Skip to main content
POST
Create Webhook

Authentication

Requires an API key in the Authorization header.

Request

string
required
The HTTPS URL to receive webhook deliveries.
string[]
required
List of event types to subscribe to. At least one event is required.Valid events: lookup.completed, apikey.created, apikey.revoked, credits.low, credits.exhausted
string
Optional description for the webhook.

Example request

Response

Returns the created webhook object, including the signing secret.
string
Unique webhook identifier (UUID).
string
The registered webhook URL.
string
The HMAC-SHA256 signing secret. Only returned at creation time store it securely.
string[]
Subscribed event types.
boolean
Whether the webhook is active (defaults to true).
string
Webhook description.
string
ISO 8601 creation timestamp.

Example response

The secret is only returned when you create the webhook. Store it securely you’ll need it to verify webhook signatures.