Register a Webhook

Register a new webhook to receive notifications for monitoring alerts

Allows you to register a new webhook to receive notifications for monitoring alerts. This can include Breach, Identity, and BIN Monitoring alerts.

post

/webhooks

Authorizations

Body

urlstringrequired

The URL of the webhook to send alerts to when a match is found.

Example: https://mywebhook.com

defaultboolean

If true, this webhook will be used as the default for all new monitoring requests which do not specify a webhook. This will automatically override any existing default webhook. The first webhook created on an account automatically becomes the default.

Example: false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.enzoic.com/v1/webhooks' \
  --header 'Authorization: Bearer Base64(your_api_key:your_api_secret)' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://mywebhook.com",
    "default": false
  }'

201

400

401

409

201

{
  "webhookID": "5a3ae05132ffb96e664d4626",
  "url": "https://mywebhook.com",
  "key": "51000000000000000000000000000000",
  "secret": "51000000000000000000000000000000",
  "default": false
}

The call was successful and the webhook is now available for use on your account.