Skip to main content
PATCH
Update a 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

Path Parameters

id
string
required

Body

application/json

All fields optional; nil/absent means unchanged.

url
string | null
events
string[] | null
high_risk_threshold
integer | null
Required range: 1 <= x <= 100
redact_email
boolean | null
is_active
boolean | null

Response

Updated webhook.

webhook
object
required
metadata
object
required