Understanding Webhook event payloads

Reviewed on 20 September 2024 • Published on 20 September 2024

Events triggered by webhooks contain payloads that describe and detail the events.

Find below a detailed description of the fields in a Webhoook event payload.

Tag	Description
`id`	Event identifier
`type`	Event type
`organization_id`	Domain Organization
`project_id`	Domain Project
`domain_id`	Domain identifier
`domain_name`	Domain name
`created_at`	Event creation date. Dates should be included in RFC-3339 format.
`email_sent_at`	Email reception date by the recipient server. Dates should be included in RFC-3339 format.
`email_queued_at`	Email reception date by TEM proxy or API. Dates should be included in RFC-3339 format.
`email_id`	Email identifier (used for GetEmail endpoint)
`email_from`	Email FROM address
`email_to`	Email recipient address
`email_headers`	SMTP headers
`email_error`	DEPRECATED SMTP message explaining the drop
`email_next_try`	Next time the email will be sent to the recipient server
`email_try_count`	Total number of tries attempted for this email
`email_response_code`	SMTP response code
`email_response_message`	SMTP response message

Examples of payload by event type

Webhooks may trigger different types of events. These types have varying payload fields.

email_queued

{
  "id": UUID,
  "type": "email_queued",
  "organization_id": UUID,
  "project_id": UUID,
  "domain_id": UUID,
  "domain_name": string,
  "created_at": time,
  "email_queued_at": timed,
  "email_id": UUID,
  "email_from": string,
  "email_to": string,
  "email_headers": [
    {
      "key": string,
      "value": string
    }
  ]
}

email_dropped

{
  {
  "id": UUID,
  "type": "email_dropped",
  "organization_id": UUID,
  "project_id": UUID,
  "domain_id": UUID,
  "domain_name": string,
  "created_at": time,
  "email_sent_at": time,
  "email_id": UUID,
  "email_from": string,
  "email_to": string,
  "email_headers": [
    {
      "key": string,
      "value": string
    }
  ],
  "email_sent_at": time,
  "email_error": string,
  "email_response_code": int,
  "email_response_message": string

email_delivered

{
  "id": UUID,
  "type": "email_delivered",
  "organization_id": UUID,
  "project_id": UUID,
  "domain_id": UUID,
  "domain_name": string,
  "created_at": time,
  "email_sent_at": time,
  "email_id": UUID,
  "email_from": string,
  "email_to": string,
  "email_headers": [
    {
      "key": string,
      "value": string
    }
  ],
  "email_response_code": int,
  "email_response_message": string
}

email_mailbox_not_found

{
  "id": UUID,
  "type": "email_mailbox_not_found",
  "organization_id": UUID,
  "project_id": UUID,
  "domain_id": UUID,
  "domain_name": string,
  "created_at": time,
  "email_sent_at": time,
  "email_id": UUID,
  "email_from": string,
  "email_to": string,
  "email_headers": [
    {
      "key": string,
      "value": string
    }
  ],
  "email_response_code": int,
  "email_response_message": string
}

email_spam

{
  "id": UUID,
  "type": "email_spam",
  "organization_id": UUID,
  "project_id": UUID,
  "domain_id": UUID,
  "domain_name": string,
  "created_at": time,
  "email_sent_at": time,
  "email_id": UUID,
  "email_from": string,
  "email_to": string,
  "email_headers": [
    {
      "key": string,
      "value": string
    }
  ],
  "email_response_code": int,
  "email_response_message": string
}

email_deferred

{
  "id": UUID,
  "type": "email_deferred",
  "organization_id": UUID,
  "project_id": UUID,
  "domain_id": UUID,
  "domain_name": string,
  "created_at": time,
  "email_sent_at": time,
  "email_id": UUID,
  "email_from": string,
  "email_to": string,
  "email_headers": [
    {
      "key": string,
      "value": string
    }
  ],
  "email_error": string,
  "email_next_try": time,
  "email_try_count": int,
  "email_response_code": int,
  "email_response_message": string
}