Webhook Test API

Verify your webhook implementation prior to deployment

Sends a test notification to your account's registered webhook

get

This call will cause a test POST to be sent to the webhook URL registered to your account. This allows you to verify that your webhook URL is set up properly and able to receive Breach, Identity, and/or BIN Monitoring Alerts from Enzoic.

Authorizations
Query parameters
typestringOptional

This controls the type of webhook body to send to your webhook. Possible values are:

  • breachAlert - a simulated Breach Monitoring alert payload is sent
  • piiAlert - a simulated Identity Monitoring alert payload will be sent.
  • binAlert - a simulated BIN Monitoring alert payload will be sent.

If type is not specified, the default is to send a breachAlert payload.

Default: breachAlert
webhookIDstringOptional

(Optional) If specified, the call will send the test notification to the webhook with this ID. If this parameter is not provided, the call will instead send the test notification to the default webhook registered for your account.

Responses
200
The call was successful. Your webhook should receive a test POST as a result.
get
GET /v1/webhook-test HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer Base64(your_api_key:your_api_secret)
Accept: */*

No content

Last updated

Was this helpful?