Skip to main content

Update Webhook

PUT 
/v1/webhook/update

This endpoint updates a webhook.

Conditional rules (same as register):

  • When event is EMAIL_EVENT, at least one flag inside webhook_options.events must be true.
  • When event is DOMAIN_VERIFICATION, all webhook_options.events.* flags must be false (or omitted).

Request​

Body

required

Webhook Update Payload

    event stringrequired

    Possible values: [EMAIL_EVENT, DOMAIN_VERIFICATION]

    headers object
    method string

    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 string

Responses​

webhook updated

Schema

    message string
    success boolean
Loading...