Skip to main content
POST
Receive Inbound Webhook

Authorizations

Authorization
string
header
required

Send platform JWTs, contact JWTs, or team API keys as Authorization: Bearer <token>.

Headers

authorization
string | null

Bearer whk_<secret>: the webhook's secret. The URL alone does nothing.

Path Parameters

hook_id
string
required

Body

application/vnd.api+json

One flat JSON object, at most 64 KiB. email is required; first_name and last_name fill an empty name; a key equal to a custom field slug writes that field; every other key travels with the event.

email
string<email>
required
first_name
string
last_name
string

Response

Successful Response

data
JsonApiResource[InboundWebhookReceiptAttributes] · object
required
included
any[] | null
meta
Meta · object | null