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

Was this helpful?

  1. API reference
  2. Breach Monitoring API
  3. Webhooks

Webhook Test API

Verify your webhook implementation prior to deployment

PreviousQuery Registered WebhooksNextIdentity Breach Monitoring API

Last updated 10 months ago

Was this helpful?

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.
404
No webhook URL is registered for your account. Contact support to have a URL added.
get
GET /v1/webhook-test HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer Base64(your_api_key:your_api_secret)
Accept: */*

No content