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 Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/epJz18oziyWLUe8-qVJpz_image.png?format=webp)
ο»Ώ
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.
- 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 Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/8A61-4SGt7-km6PEyW2-Y_image.png?format=webp)
ο»Ώ
- 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 Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/e_YNyl5BZ5PbHYjrmHLjC_image.png?format=webp)
ο»Ώ
Static response (JSON):
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/gHqYvKv7KsZcwJSHyLzGc_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/BOv1zUHxPpEweX7NZv2Ir_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/llzBjRZh576soJRuBf9ua_image.png?format=webp)
ο»Ώ
Scripting (JavaScript):
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/OpS5Y2NkeOyf69HQ9xftI_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/_DqZZhev_Ma4E3y9N4hMS_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/sZAA53RuT-mQyveE8Oj0r_image.png?format=webp)
ο»Ώ
JSONPath:
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/RQvytkViI5U4IOo2ychSL_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/GtgBcQWyEardi37zIUurp_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/pSTdctmuviRx_9ef4PTr2_image.png?format=webp)
ο»Ώ
This section is designed to return a custom response when the webhook is assigned to a process. I
- Create a webhook and trigger it to get the Data Models Structure:
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/UIuEcAa8hJ71McA9mkCgG_image.png?format=webp)
ο»Ώ
- Open the Configure Response panel and expand the Custom Response Body.
- Configure the Custom Response:
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/hkU1g9MWgODOjNdLpA-0y_image.png?format=webp)
ο»Ώ
- Save the webhook.
- Create a process.
- Open the webhook pannel and assign the webhook to the process:
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/6M91NVbOGh_H2orsxKBS4_image.png?format=webp)
ο»Ώ
![Document image Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/v0kbd9w21xRdSeAhr9LxR_image.png?format=webp)
ο»Ώ
- 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 Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/HyeEw-hPhT41p7eZE669A_image.png?format=webp)
ο»Ώ
- 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 Document image](https://images.archbee.com/pD-o7nZLwDiSBwGlsHA9q/DCOOVzREchqLWz00pb7Hj_image.png?format=webp)
ο»Ώ
ο»Ώ
Updated 02 Nov 2023
Did this page help you?