Webhook Post

The Webhook Post component lets you post a payload to a unique URL. A webhook is an automated message that is sent from an app upon the occurrence of an event, and contains a message—or payload—that is sent to the unique URL. The outbound payload isn’t signed with HMAC, so receiving endpoints can’t use HMAC to verify the request.

The Webhook Post component only sends outbound webhooks. You can’t use it to send an incoming webhook to , which means that it can’t be used to trigger a pipeline run or pass data into a pipeline.

---

Prerequisites

To configure Webhook as a delivery channel, you need the incoming webhook URL that represents where to send the message. For more information about obtaining the incoming webhook URL in your chosen destination, read the destination provider’s incoming webhook documentation.

---

Properties

Snowflake

Name · string · required

Enter a human-readable name for the component.

Incoming Webhook URL · string · required

Enter a valid incoming webhook URL. The URL must start with HTTP or HTTPS.

Payload Template · drop-down · required

The default setting is [Custom].

Payload · JSON · required

Enter a valid JSON payload body. If the payload is not valid JSON, an error message will be displayed: “Payload is not valid JSON”.

To use variables in this field, type the name of the variable prefixed by the dollar symbol and surrounded by { } brackets, as follows: ${variable}. Once you type ${, a drop-down list of autocompleted suggested variables will appear. This list updates as you type; for example, if you type ${date, functions and variables containing date will be listed.

Databricks

Name · string · required

Enter a human-readable name for the component.

Incoming Webhook URL · string · required

Enter a valid incoming webhook URL. The URL must start with HTTP or HTTPS.

Payload Template · drop-down · required

The default setting is [Custom].

Payload · JSON · required

Enter a valid JSON payload body. If the payload is not valid JSON, an error message will be displayed: “Payload is not valid JSON”.

To use variables in this field, type the name of the variable prefixed by the dollar symbol and surrounded by { } brackets, as follows: ${variable}. Once you type ${, a drop-down list of autocompleted suggested variables will appear. This list updates as you type; for example, if you type ${date, functions and variables containing date will be listed.

Amazon Redshift

Name · string · required

Enter a human-readable name for the component.

Incoming Webhook URL · string · required

Enter a valid incoming webhook URL. The URL must start with HTTP or HTTPS.

Payload Template · drop-down · required

The default setting is [Custom].

Payload · JSON · required

Enter a valid JSON payload body. If the payload is not valid JSON, an error message will be displayed: “Payload is not valid JSON”.

To use variables in this field, type the name of the variable prefixed by the dollar symbol and surrounded by { } brackets, as follows: ${variable}. Once you type ${, a drop-down list of autocompleted suggested variables will appear. This list updates as you type; for example, if you type ${date, functions and variables containing date will be listed.

Google BigQuery

Name · string · required

Enter a human-readable name for the component.

URL · string · required

Enter a valid webhook URL. The URL must start with HTTP or HTTPS.

Payload · JSON · required

A valid JSON payload body. If the payload is not valid JSON, an error message will be displayed: “Payload is not valid JSON”.

To use variables in this field, type the name of the variable prefixed by the dollar symbol and surrounded by { } brackets, as follows: ${variable}. Once you type ${, a drop-down list of autocompleted suggested variables will appear. This list updates as you type; for example, if you type ${date, functions and variables containing date will be listed.

You can also define new variables in the payload body, limited in scope to only this component, by enclosing a name in curly braces. For example {{ variableName }} will create a new variable called variableName. Any variables you add in this way should be given values in the Payload variables property.

Payload variables · column editor

Any new variables you defined in the payload body should have their values defined here.

• Name: Select a variable from the drop-down. The drop-down contains all variables defined in the payload body.
• Value: Enter the variable value. The value will be substituted for the variable each time it appears in the payload body.

Timeout (seconds) · string · required

The maximum time to wait for the endpoint to respond, in seconds.