Automation
Webhooks

Configure Response

10min

The Configure Response Panel is where the webhook body can be configured and it is divided in 2 section, Handshake Response Body and Custom Response Body:

Document image
ο»Ώ

Handshake Response Body

This section is designed to help validating the webhook response. When the webhook is created, the Handshake response body can be configured to return the specific payload that the third-party app is expecting.

Handshake Response Body Configuration:

  • Create a new webhook.
  • Copy the unique webhook URL in the webhook configuration in external app.
  • Open the Configure Response panel and expand the Handshake Response Body section:
Document image
ο»Ώ
  • There are 3 options for the Response configuration method: Static response, JavaScript and JSONPath. After the response is configured, listen to the handshake and trigger the webhook from the third-party app to receive the response:
Document image
ο»Ώ

Static response (JSON):

Document image
ο»Ώ
Document image
ο»Ώ
Document image
ο»Ώ

Scripting (JavaScript):

Document image
ο»Ώ
Document image
ο»Ώ
Document image
ο»Ώ

JSONPath:

Document image
ο»Ώ
Document image
ο»Ώ
Document image
ο»Ώ

Custom Response body:

This section is designed to return a custom response when the webhook is assigned to a process. I

Custom Response body configuration:

  • Create a webhook and trigger it to get the Data Models Structure:
Document image
ο»Ώ
  • Open the Configure Response panel and expand the Custom Response Body.
  • Configure the Custom Response:
Document image
ο»Ώ
  • Save the webhook.
  • Create a process.
  • Open the webhook pannel and assign the webhook to the process:
Document image
ο»Ώ
Document image
ο»Ώ
  • After the webhook is assign, open the Custom Response panel and here you can set as custom response an attribute from the webhook data model or a variable from the process:
Document image
ο»Ώ
  • Select a variable or an attribute and trigger the webhook from the third-party app. This will start the process and return the Custom response:
Document image
ο»Ώ

ο»Ώ