Webhooks Events

Email Opt-Out Created

This event is triggered when a recipient opts out of survey emails.

The event payload contains the event timestamp and the opted-out email address.

postWebhookemailOptOutCreated

Payload

type'email_opt_out_created'

Example payload

{
  "payload": {
    "email_address": "jane.doe@example.com",
    "created_at": "2024-11-27T16:10:44.929678Z"
  }
}

Response

Return a 200 status to indicate that the event was properly received

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.