v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Add 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.

post/events/webhook

Request body

transformerType'WebEngageTransformer' required

Currently, only WebEngageTransformer is supported.

tillCodestring required

Till code to associate with the current Webhook. All events data that are posted through the current Webhook’s URL will be associated to this store TILL.

authEnabledboolean

To enable the authentication

authMechanismstring

Defines the authentication mechanism

uniquenessCheckEnabledboolean

Enable or disable the uniqueness check.

Response

200

transformerTypestring

uniquenessCheckEnabledboolean

tillCodestring

webHookUristring

authEnabledboolean

Example response

{
  "transformerType": "WebEngageTransformer",
  "tillCode": "rutuja_capillary",
  "webHookUri": "https://spd6hzcltl.execute-api.eu-west-1.amazonaws.com/eucrm/webhooks/e4492fc546c93453ff177f356356a7b3"
}