Webhook Test API

Verify your webhook implementation prior to deployment

Sends a test notification to your account's registered webhook

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.

get

/webhook-test

Authorizations

Query parameters

typestring · default: breachAlert

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.

webhookIDstring

(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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.enzoic.com/v1/webhook-test' \
  --header 'Authorization: Basic username:password'

200

404

200

No body

The call was successful. Your webhook should receive a test POST as a result.