Enzoic API - Developer Documentation
Visit our website
  • Enzoic Website
  • Getting Started
    • .NET Quick Start
    • Java Quick Start
    • JavaScript Quick Start
    • Ruby Quick Start
    • PHP Quick Start
    • Go Quick Start
    • Python Quick Start
  • Using the Enzoic API
  • Libraries
  • API reference
    • Passwords API
    • Credentials API
      • Hashed Credentials API
      • Cleartext Credentials API
        • Query Passwords for an Email Address
        • Query Passwords for a Domain
        • Query Passwords for a Partial Hash of an Email Address
      • Test Accounts
    • Exposures API
      • Get Exposures for an Email Address
      • Get Exposures for a Domain
      • Get Exposures for All Email Addresses in a Domain
      • Get Exposures by Date
      • Retrieve Details for an Exposure
    • Breach Monitoring API
      • Breach Monitoring by User
        • Add Breach Alert Subscriptions for Users
        • Remove Breach Alert Subscriptions for Users
        • Query Breach Alert Subscriptions for Users
      • Breach Monitoring by Domain
        • Add Breach Alert Subscriptions for Domains
        • Remove Breach Alert Subscriptions for Domains
        • Query Breach Alert Subscriptions for Domains
      • Webhooks
        • Managing Webhooks
          • Register a Webhook
          • Update a Webhook
          • Delete a Webhook
          • Query Registered Webhooks
        • Webhook Test API
    • Identity Breach Monitoring API
      • Monitoring Identities
        • Add Identities to Monitoring
        • Update Monitored Identities
        • Remove an Identity from Monitoring
        • Query Monitored Identities
      • Retrieving Identity Exposures
      • Webhooks
        • Managing Webhooks
          • Register a Webhook
          • Update a Webhook
          • Delete a Webhook
          • Query Registered Webhooks
        • Webhook Test API
    • BIN Monitoring API
      • Monitoring BINs
        • Add Bank Identification Numbers to Monitoring
        • Remove Bank Identification Numbers from Monitoring
        • Query Monitored Bank Identification Numbers
      • Retrieving Exposed Payment Cards
      • Webhooks
        • Managing Webhooks
          • Register a Webhook
          • Update a Webhook
          • Delete a Webhook
          • Query Registered Webhooks
        • Webhook Test API
    • Payment Card Exposures API
      • Check a Card Number for Compromise
    • Account Status APIs
      • Account Status
      • Account Usage
    • Password Hash Algorithms
    • OpenAPI Specification
    • View OpenAPI Spec in Swagger UI
    • Postman Collection of API Examples
  • Password Strength Meter
    • Quick Start
    • Example
Powered by GitBook
On this page
  • Webhook POST Body
  • Webhook Authentication
  • Mutual TLS (mTLS) Authentication (Optional)
  • Setting Up mTLS
  • Payload Encryption (Optional)
  • Testing Your Implementation

Was this helpful?

  1. API reference
  2. Breach Monitoring API

Webhooks

Webhooks are where breach notifications get sent

PreviousQuery Breach Alert Subscriptions for DomainsNextManaging Webhooks

Last updated 2 months ago

Was this helpful?

To use the Breach Monitoring Service, it is necessary to setup a Webhook with Enzoic. You will need to specify a URL on your end that will be called with a POST whenever a notification is made. This can be done via API using the or by . You will also receive a Webhook Key and Webhook Secret which will be passed to your endpoint via basic HTTP authentication.

NOTE: Webhook notifications will be sent from IP address: 52.42.159.171. You may need to update your firewall rules accordingly.

Webhook POST Body

The content of the POST body that will be sent to your webhook for new Breach Monitoring notifications will be a JSON object with the members specified in the table below.

Additional JSON keys may be added to this payload as we make enhancements to the service, so you must implement JSON parsing for the webhook in a way that will not fail if additional data members are present.

Member
Type
Description

date

date

The date/time (in GMT) that the Exposure was found

exposureID

string

username

string

The email address which was exposed.

usernameHash

string

The SHA-256 hash of the email address exposed.

plaintextPassword

string

The cleartext version of the password which was found. If the cleartext password was not recoverable, the passwordHash will contain the hashed version of the password, in which case you can hash a password on your end using the algorithm in passwordType and compare it to the passwordHash value to determine if there is a match. This field will only be present when cleartext credentials API access is enabled.

passwordHash

string

The hashed value of the password which was found, if the source data contained a password hash rather than the cleartext password. This field will only be present when cleartext credentials API access is enabled.

passwordSalt

string

If the password was hashed and a separate salt value is required for this hash type, this is the salt value which was found. This field will only be present when cleartext credentials API access is enabled.

passwordType

int

customData

string

exposureDetails

object

An example POST body:

{ 
  "username": "sample@email.tst",
  "usernameHash": "de34a09f96a6677f8a4e0a17545a20e0b60a2f093879c82ed36cff75930d5814",
  "date": "2017-01-17T04:51:05.1915231Z",
  "exposureID": "583d32144d6db21a908faa11",
  "plaintextPassword": "password123!", // only present if cleartext credentials are enabled
  "passwordHash": "b7e283a09511d95d6eac86e39e7942c0", // only present if cleartext credentials are enabled
  "passwordSalt": "", // only present if cleartext credentials are enabled
  "passwordType": 1,
  "customData": "corporate_users",
  "exposureDetails": {
    "title": "test exposure",
    "date": "2015-05-01T00:00:00.000Z",
    "entries": 5123,
    "domainsAffected": 683,
    "category": "Manufacturing",
    "sourceURLs": [
      "https://somecybercriminalforum.com/post123"
    ],
    "source": "Cybercrime Forums",
    "passwordTypes": [
      1
    ],
    "exposedData": [
      "Emails",​
      "Passwords"​
    ],
    "dateAdded": "2016-09-16T15:36:54.000Z"
  }
}

Webhook Authentication

For security reasons, you should authenticate calls to your Webhook endpoint. To facilitate this, you will be provided with a Webhook Key and a Webhook Secret when you setup your Webhook with Enzoic. These will be passed as a standard basic authentication HTTP with the Webhook Key as the username and the Webhook Secret as the password. As per the standard, the authentication header passed to your endpoint is constructed as follows:

authorization: basic Base64({Webhook Key}:{Webhook Secret})

Mutual TLS (mTLS) Authentication (Optional)

If you use an HTTPS endpoint for your webhook's URL, Enzoic will by default confirm that your server certificate is valid prior to posting data by ensuring it is issued by a trusted Certificate Authority and the subject of the certificate matches the webhook domain. This is to help ensure we are communicating with your server and not an unauthorized 3rd party.

Mutual TLS (mTLS) is an optional authentication you may leverage in your webhook to verify that the call actually originated with Enzoic. To take advantage of mTLS, you configure your server to verify Enzoic's client certificate. Enzoic always attempts to send this certificate, so there is no need for any additional configuration on the Enzoic side to enable this functionality.

Setting Up mTLS

To setup mTLS, you will need to do the following:

  1. Configure your web server to require client certificate verification using the certificate from step 1 as the trusted root CA and setting the verification depth to 1.

  2. Verify the client certificate is actually from Enzoic by verifying the subject domain name is webhooks.enzoic.com

Although the client certificate configuration will be specific to your web server, example configurations for NGINX and Apache are below.

NGINX Example Configuration

    server {
        listen       443 ssl;
        
        # ... existing server configuration ...

        # mTLS client certificate configuration 
        ssl_verify_client on;
        ssl_client_certificate /path/to/Enzoic-RootCA-2025.crt;
        ssl_verify_depth 1;

        location / {           
            # check that the client cert's distinguished name matches
            # the expected value, otherwise reject with 403
            if ($ssl_client_s_dn !~ "CN=webhooks.enzoic.com") {
                return 403;
            }
            
            # ... existing location configuration ... #
        }
    }

Apache Example Configuration

Listen 443
<VirtualHost *:443>
    # ... existing SSL configuration for server authentication ...
    SSLVerifyClient require
    SSLCACertificateFile "/path/to/Enzoic-RootCA-2025.crt"
    SSLVerifyDepth 1
</VirtualHost>
<Directory /var/www/>
    Require expr "%{SSL_CLIENT_S_DN_CN} == 'webhooks.enzoic.com'"
    # ... existing directory configuration ...
</Directory>

Payload Encryption (Optional)

Enzoic can optionally encrypt the webhook body with a pre-shared key, using AES encryption. In this case the body of the call will contain a Base64 encoded encrypted version of the JSON payload. It will be necessary to decrypt the received Base64 payload using the pre-shared key. This provides another safeguard to protect the sensitive data contained in the webhook call against unauthorized interception.

Testing Your Implementation

Once you have your webhook up and publicly accessible, you can verify all is working using the Webhook Test REST Call using the type=breachAlert query string parameter. This will cause a Breach Monitoring Notification POST to be made to your URL containing test data.

The ID of the Exposure. This can subsequently be used with the to retrieve additional information about the Exposure.

The hash algorithm for the value in the passwordHash field. See the page for more details. This field will only be present when cleartext credentials API access is enabled.

This will contain the customData value you provided along with this username when you subscribed it for monitoring, see . Will not be present if the notification is for a monitored domain.

The exposure details object contains detailed information about how and where these credentials were exposed. See for documentation on the contents.

You can read more about mTLS for webhook security at .

Download the Enzoic root certificate from

to discuss enabling this feature for your webhooks.

Webhooks API
contacting Enzoic Support
https://webhooks.fyi/security/end-to-end-encryption
https://cdn.enzoic.com/certs/Enzoic-RootCA-2025.crt
Contact Enzoic support
Breach Monitoring by User
Retrieve Details for an Exposure
GET Exposure Details API
Password Hash Algorithms