post https://{host}/v2/events/webhook
A Webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webHookUri is generated which can be used for the integration.
Request Body Parameters
| Parameter | Type | Description |
|---|---|---|
| transformerType | string | Specifies the type of transformer used to process incoming webhook data. |
| tillCode | string | Till code to associate with the current Webhook. Events posted through this Webhook’s URL will be linked to this store TILL. |
| authEnabled | boolean | Enables authentication for the Webhook. |
| authMechanism | string | Defines the authentication mechanism (e.g., Basic). |
| uniquenessCheckEnabled | boolean | Enables or disables the uniqueness check for events. |
{
"transformerType": "WebEngageTransformer",
"tillCode": "rutuja_capillary",
"authEnabled": false,
"authMechanism": "Basic",
"uniquenessCheckEnabled": false
}
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| transformerType | string | Indicates the transformer type used (e.g., "WebEngageTransformer"). |
| uniquenessCheckEnabled | boolean | If true, duplicate events are filtered; if false, all events are processed. |
| tillCode | string | The Till code associated with the webhook for store mapping. |
| webHookUri | string | The auto-generated URL where events should be sent (unique to this webhook). |
| authEnabled | boolean | Indicates whether authentication is enabled (true/false). |
| warnings | array | Lists non-critical issues during webhook creation. |
{
"transformerType": "WebEngageTransformer",
"uniquenessCheckEnabled": false,
"tillCode": "rutuja_capillary",
"webHookUri": "https://spd6hzcltl.execute-api.eu-west-1.amazonaws.com/eucrm/webhooks/e4492fc546c93453ff177f356356a7b3",
"authEnabled": false,
"warnings": []
}
API specific Error code
| Error Code | Description | Reason |
|---|---|---|
| 1839 | auth mechanism not present | authenabledfield passed as false |
| 1808 | customer event transformer not present | Invalid or unsupported transformertype |
For information on event uniqueness check, see Event uniqueness check.