Webhook component

Overview

The webhook component is an open source component for sending and receiving webhooks on Squiz Connect.

Credentials

The webhook component supports the following authorisation types:

  • No Auth - use this method to work with any open REST API

  • Basic Auth - use it to provide login credentials like username/password

  • API Key Auth - use it to provide API Key to access the resource

  • HMAC verification shared secret - use it to verify via a shared secret.

    The only encryption algorithm supported is SHA512.
creds

Triggers

Receive

When used as the first step in a flow, the webhook component is used as a trigger, which receives data as input, and then commences the rest of the flow’s execution.

Example:

  {
    "recievedBody": "recievedBody",
    "_query": {},
    "_headers": {
      "content-type": "application/json",
      "accept": "*/*",
      "accept-encoding": "gzip, deflate"
    },
    "_method": "POST",
    "_url": "/hook/5d691738cb5a286adc1e68e2"
  }

Actions

Send data

When not used as the first step in a flow, this webhook component sends the data it receives as input to the URL provided.

The webhook action can also be used to troubleshoot many processes to observe their outcome. For example one could create Invoices (in Salesforce) as a webhook action in a flow and configure this component with a URL created in https://webhook.site or with any similar services.

List of Expected Config fields

  • HTTP Verb

    • POST. The webhook component can POST information to a pre-configured webhook address. This action could be used for different purposes. For example, the webhook component can be used to inform a custom connector about an event which the connector is waiting for.

    • PUT. The webhook component can also PUT a specific pre-configured JSON object through a specific address where the process will not be handled by the server. For this reason the "Output JSON Sample" field can be used.

  • URI. This is the address to send the webhook action.

  • ( optional ) Secret. This is an optional field to authenticate webhook POST. There maybe cases when a special password or a secret might be required. For example, the webhook address was generated explicitly with a password to prevent any third parties from using this address. This could be your specific webhook address that you use to send your Wordpress posts to your server.

Webhookcredentials

Example:

    {
        "recievedBody": "recievedBody",
        "_query": {},
        "_headers": {
          "content-type": "application/json",
          "accept": "*/*",
          "accept-encoding": "gzip, deflate"
        },
        "_method": "POST",
        "_url": "/hook/5d691738cb5a286adc1e68e2"
      }

Known limitations

  1. The maximum possible size for an attachment is 10 MB.

© 2015- Squiz Pty Ltd