Verify a webhook

1 min

GET

https://api.campaign.episerver.net/rest/{clientId}/webhooks/{webhookId}/verify

Verify a webhook. The request is sent to the configured target URL to check if the webhook is ready to use. If successful, the value "200" is returned in the "httpStatusCode" field of the JSON response. In case of errors check the "responseBody" field.

clientIdinteger<int64>Client ID

webhookIdinteger<int64>Webhook ID

mailingIdinteger<int64><p>ID of a valid mailing (e.g. test mailing in Smart Campaigns). For blacklist webhooks any valid customer's mailing ID can be used.</p>

numberOfEventsinteger<int32><p>Number of events to send (max. 100)</p>

acceptstringGenerated from available response content types

200The webhook test request was executed successfully.

400The verification of the webhook is not supported for the provided type.

curl --request GET \
     --url 'https://api.campaign.episerver.net/rest/{clientId}/webhooks/{webhookId}/verify?mailingId=integer%3Cint64%3E&numberOfEvents=1' \
     --header 'accept: application/json'