Update Webhook

put

https://{host}/v3/webHooks/{webHookId}

Update an existing webhook.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webHookId

string

required

Identifier for the webhook.

Body Params

active

boolean

Indicates if the webhook is active.

customerIdentifiersToBeEnriched

array of strings

List of customer identifiers enrichment available in the payload.

customerIdentifiersToBeEnriched

eventNames

array of strings

List of event names that trigger the webhook.

eventNames

maxAllowedConnections

int32

Maximum allowed concurrent connections for this webhook.

methodType

string

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

name

string

Name of the webhook.

slaInSeconds

int32

Expected delivery time of the event notification in seconds. This is used to track notifications that took more time than the SLA set.

webHookHeaders

array of strings

Headers sent with the webhook request.

webHookHeaders

webHookType

string

Type of webhook, Example: HTTP

webHookUrl

string

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