messaging.message.treated

Payload JSON

{
  "eventBatchId": "d1114ee6-4b06-43f0-b034-2f98acb27bf1",
  "eventSubscriptionId": "7477120c-0229-44ea-9d87-b36fef2566ef",
  "eventBatchTime": "2026-03-31T13:59:53.3712465Z",
  "eventsData": [
    {
      "eventType": "message.treated",
      "eventVersion": 1,
      "eventData": {
        "registeredOn": "2026-03-31T13:59:52Z",
        "messageId": "b6b2961a-d32d-45e0-a2ea-2bc1219e5ee2",
        "conversationId": "803233ba-1935-4a4d-8af5-4bd9a5d45245",
        "conversationType": "groupchat",
        "sender": {
          "senderId": "8340b144-e4d3-463b-a6d3-b8ea6074651c",
          "roleType": "Driver"
        },
        "recipientId": "803233ba-1935-4a4d-8af5-4bd9a5d45245",
        "contentType": "text",
        "content": "1",
        "replyToMessageId": null,
        "statusHistory": {
          "currentStatus": "Treated",
          "lastUpdatedAt": "2026-03-31T13:59:52Z",
          "events": [
            {
              "status": "Pending",
              "timestamp": "2026-03-31T13:57:37Z"
            },
            {
              "status": "Delivered",
              "timestamp": "2026-03-31T13:59:52Z"
            },
            {
              "status": "Treated",
              "timestamp": "2026-03-31T13:59:52Z",
              "participant": {
                "participantId": "1e8ee916-ab83-4402-8048-0d949231d586",
                "roleType": "User"
              }
            }
          ]
        }
      }
    }
  ]
}

Field level Description

Field	Type	Optional/Required	Description
eventBatchId	String (UUID)	Required	A unique identifier for this batch of events. Multiple events occurring close together may be grouped into a single batch.
eventSubscriptionId	String (UUID)	Required	A unique identifier representing the subscription through which this event was delivered. It ensures traceability between the event and the organization's registered DHS subscription.
eventBatchTime	DateTime (ISO 8601 timestamp, UTC)	Required	The timestamp when this event batch was created and prepared for delivery.
eventsData	Array	Required	An array containing one or more message event objects. Multiple messages can be batched together if they occur in close temporal proximity.
eventsData[].eventType	String	Required	The type of event. For this event: message.treated.
eventsData[].eventVersion	Integer	Required	The version of the event schema. Currently 1.
eventsData[].eventData	Object	Required	Contains the message event payload data.
eventData.registeredOn	DateTime (ISO 8601 timestamp, UTC)	Required	The timestamp when this event was registered in the system.
eventData.messageId	String (UUID)	Required	A globally unique identifier assigned to this specific message instance. Used for message tracking, deduplication, and referencing in subsequent status updates.
eventData.conversationId	String (UUID)	Required	Identifies the groupchat conversation in which this message was sent. All messages within the same conversation share this identifier.
eventData.conversationType	String	Required	Indicates the type of conversation where the message was sent. For this event, the value is always: groupchat — Group conversation with multiple participants. The treated status is exclusive to groupchat conversations and does not apply to one-to-one chat.
eventData.sender	Object	Required	Contains information about the message sender.
eventData.sender.senderId	String (UUID)	Required	The unique identifier of the user who sent the message.
eventData.sender.roleType	String	Required	The role of the sender within the system. Examples include: User — Standard user. Driver — Vehicle driver.
eventData.recipientId	String (UUID)	Required	The unique identifier of the message recipient. For groupchat, this is the group conversation ID.
eventData.contentType	String	Required	Specifies the format of the message content. Supported values: text — Plain text message content. image — Image attachment. file — File attachment (currently supports PDF only).
eventData.content	String	Optional	The message text when contentType is text, or an optional caption when contentType is image or file.
eventData.replyToMessageId	String (UUID) or null	Required	The message ID of the original message being replied to. Set to null if the message is not a reply.
eventData.statusHistory	Object	Required	Contains the complete status lifecycle information for this message, including current status and historical events.
statusHistory.currentStatus	String	Required	The current delivery status of the message. For this event: Treated — A participant has marked the message as treated or resolved. This status is independent of the seen status.
statusHistory.lastUpdatedAt	DateTime (ISO 8601 timestamp, UTC)	Required	The timestamp when the message status was last updated. This reflects when the message was marked as treated.
statusHistory.events	Array	Required	An ordered array of status transition events, providing a complete audit trail of the message lifecycle. Each event represents a state change. Note that Treated can occur independently of seen status.
statusHistory.events[].status	String	Required	The status that the message transitioned to. Possible values in this payload: Pending — Message was successfully sent from the sender. Delivered — Message was confirmed delivered to recipient device(s). Treated — Message was marked as treated by a participant, triggered by calling PATCH /v1/messages/actions/treat.
statusHistory.events[].timestamp	DateTime (ISO 8601 timestamp, UTC)	Required	The timestamp when this specific status transition occurred.
statusHistory.events[].participant	Object	Optional	Contains information about the participant who triggered the status change. Present on the Treated status event.
statusHistory.events[].participant.participantId	String (UUID)	Required	The unique identifier of the participant who marked the message as treated. This identifies which team member acknowledged or resolved the message.
statusHistory.events[].participant.roleType	String	Required	The role of the participant. Examples include: User — Standard user. Driver — Vehicle driver.