Skip to main content
POST
Register webhook

Use Case:

Register a webhook endpoint for asynchronous job notifications.

Authorizations

Authorization
string
header
required

Use the required Token prefix. Example: Authorization: Token xxxxxxxxx

Body

application/json
url
string
required

Your HTTPS endpoint URL to receive webhook events.

Example:

"https://your-app.com/webhook"

events
enum<string>[]
required

Events to subscribe to.

Available options:
email.find.bulk.completed,
phone.find.bulk.completed,
enrich.lead.bulk.completed,
enrich.company.bulk.completed
Example:
secret
string

Secret for HMAC signature verification of incoming webhook payloads.

Example:

"your-secret-for-signature"

Response

Webhook registered

id
string

Webhook identifier.

url
string

Your HTTPS endpoint that receives events.

events
string[]

Subscribed event types.

secret
string

Secret used for HMAC signature verification.

is_active
boolean
created_at
string<date-time>
updated_at
string<date-time>