Messaging events

This page documents webhook request payloads for messaging events. For an overview, see Webhook event types.

Detail object properties

For messaging events, the detail object contains the following properties:

• id

Event types

The following sections contain example payloads and event object properties for messaging event types.

Event type	Payload and properties
zen:event-type:messaging_ticket.message_added	Message added

Message added

A chat message was added by an end user, agent, or trigger.

{
  "account_id": 21825834,
  "detail": {
    "id": "141"
  },
  "event": {
    "actor": {
      "id": "zd:answerBot",
      "name": "Z3n Tests (ff66ff 403433/1724317083)",
      "type": "system"
    },
    "message": {
      "body": "Hi there. How can I help you today?",
      "id": "67ab5f55155becd183e284cb"
    }
  },
  "id": "01JQMQH83YNAKWSWJ8B1QH2NSC",
  "subject": "zen:ticket:141",
  "time": "2025-02-11T14:32:05.254571515Z",
  "type": "zen:event-type:messaging_ticket.message_added",
  "zendesk_event_version": "2022-11-06"
}

The event object contains the following properties.

Property	Data type	Description
actor	object	Contains the actor id, name, and type
actor.id	string	The actor id
actor.name	string	The actor name
actor.type	string	The actor type. Possible values: "end_user", "agent", "trigger", "system"
message	object	Contains the message id and body
message.id	string	The message id
message.body	string	The message body