Add Webhook

post

https://{host}/v3/webHooks

Add a new webhook for event notification.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

active

boolean

required

Indicates if the webhook is active.

customerIdentifiersToBeEnriched

array of strings

required

List of customer identifiers to be enriched.

customerIdentifiersToBeEnriched*

eventNames

array of strings

required

List of event names that trigger the webhook.

eventNames*

maxAllowedConnections

int32

required

Maximum connections allowed at the same time for this webhook.

methodType

string

required

HTTP method used by the webhook. Example: POST, PUT, GET or DELETE.

name

string

required

Name of the webhook.

slaInSeconds

int32

Expected delivery time of the event notification in seconds.

webHookHeaders

array of strings

required

Headers sent with the webhook request.

webHookHeaders*

webHookType

string

required

Type of webhook, Example: HTTP

webHookUrl

string

required

URL where the webhook sends its requests.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400