Skip to main content
POST
Create an outbound webhook

Authorizations

Authorization
string
header
required

First-party API key. Send the canonical key as a Bearer token:

Used on all API-client routes (/v1/analyze-email, batch, bulk, customer webhooks). Scopes (analyze, bulk, webhooks) authorize a route; the account plan authorizes premium functionality.

Headers

X-Request-ID
string

Optional client-supplied request id. The server always echoes an X-Request-ID response header; malformed/too-long values are replaced. Safe to include in support reports. Not an idempotency key.

Maximum string length: 128

Body

application/json
url
string
required

HTTPS endpoint to deliver events to.

events
enum<string>[]
required
Available options:
signup.high_risk,
bulk.job_completed
high_risk_threshold
integer
default:75

Score threshold for signup.high_risk delivery.

Required range: 1 <= x <= 100
redact_email
boolean
default:false

Redact the email from the delivered payload.

Response

Webhook created (secret reveal-once).

webhook
object
required
metadata
object
required