Skip to main content

Register Webhook

POST 
/v1/webhook/register

This endpoint registers a webhook.

Conditional rules:

  • When event is EMAIL_EVENT, at least one flag inside webhook_options.events must be true (delivery, open, click, bounce, spam, unsubscribe, policy_rejection, generation_failure, generation_rejection, smtp_error).
  • When event is DOMAIN_VERIFICATION, all webhook_options.events.* flags must be false (or omitted).

Request​

Body

required

Webhook Payload

    event stringrequired

    Possible values: [EMAIL_EVENT, DOMAIN_VERIFICATION]

    headers object
    method stringrequired

    Possible values: [POST]

    Default value: POST

    webhook_options

    object

    events

    object

    bounce boolean
    click boolean
    delivery boolean
    generation_failure boolean
    generation_rejection boolean
    imap_error boolean
    open boolean
    phishing boolean
    policy_rejection boolean
    smtp_error boolean
    spam boolean
    unsubscribe boolean
    webhook_url stringrequired

Responses​

Webhook created

Schema

    message string
    success boolean
Loading...