messaging.message.delivered

Payload JSON

Chat Message Delivered

{
  "eventBatchId": "fa9fec48-12f2-49c1-b47b-2b7d15fec41f",
  "eventSubscriptionId": "7477120c-0229-44ea-9d87-b36fef2566ef",
  "eventBatchTime": "2026-03-31T14:12:43.4451111Z",
  "eventsData": [
    {
      "eventType": "message.delivered",
      "eventVersion": 1,
      "eventData": {
        "registeredOn": "2026-03-31T14:12:38Z",
        "messageId": "06033478-37f2-469e-8e04-4fa764ab66f2",
        "conversationId": "1e8ee916-ab83-4402-8048-0d949231d586:8340b144-e4d3-463b-a6d3-b8ea6074651c",
        "conversationType": "chat",
        "sender": {
          "senderId": "1e8ee916-ab83-4402-8048-0d949231d586",
          "roleType": "User"
        },
        "recipientId": "8340b144-e4d3-463b-a6d3-b8ea6074651c",
        "contentType": "text",
        "content": "8",
        "replyToMessageId": null,
        "statusHistory": {
          "currentStatus": "Delivered",
          "lastUpdatedAt": "2026-03-31T14:12:38Z",
          "events": [
            {
              "status": "Pending",
              "timestamp": "2026-03-31T14:12:13Z"
            },
            {
              "status": "Delivered",
              "timestamp": "2026-03-31T14:12:30Z"
            }
          ]
        }
      }
    }
  ]
}

Group chat Message Delivered

{
  "eventBatchId": "030db07f-6e95-470e-8cc0-a371f9deed2b",
  "eventSubscriptionId": "517db07f-6e95-475e-8cc0-a371f9deed2b",
  "eventBatchTime": "2026-03-03T10:30:20.123Z",
  "eventsData": [
    {
      "eventType": "message.delivered",
      "eventVersion": 1,
      "eventData": {
        "registeredOn": "2026-03-03T10:30:20Z",
        "messageId": "a1234567-89ab-cdef-0123-456789abcdef",
        "conversationId": "67bb1451-08c3-4bd6-b89b-2e4328af52f1",
        "conversationType": "groupchat",
        "sender": {
          "senderId": "3f94cfb0-7cac-46be-bba5-adfb1a24ee12",
          "roleType": "User"
        },
        "recipientId": "67bb1451-08c3-4bd6-b89b-2e4328af52f1",
        "contentType": "text",
        "content": "Hello, how are you?",
        "replyToMessageId": null,
        "statusHistory": {
          "currentStatus": "Delivered",
          "lastUpdatedAt": "2026-03-03T10:30:20Z",
          "events": [
            {
              "status": "Pending",
              "timestamp": "2026-03-03T10:30:15Z"
            },
            {
              "status": "Delivered",
              "timestamp": "2026-03-03T10:30:20Z"
            }
          ]
        }
      }
    }
  ]
}

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.delivered.
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	Required	Identifies the conversation (chat or groupchat) in which this message was sent. For chat, this is a composite of sender and recipient IDs. For groupchat, this is the group identifier.
eventData.conversationType	String	Required	Indicates the type of conversation where the message was sent. Allowed values: chat — One-to-one conversation between two participants. groupchat — Group conversation with multiple participants.
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 chat, this is the other participant's ID. 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: Delivered — Message has been successfully delivered to the recipient's device(s). For groupchat, this means delivery to all participants.
statusHistory.lastUpdatedAt	DateTime (ISO 8601 timestamp, UTC)	Required	The timestamp when the message status was last updated. This reflects when the delivery was confirmed.
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 from sent to delivered.
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).
statusHistory.events[].timestamp	DateTime (ISO 8601 timestamp, UTC)	Required	The timestamp when this specific status transition occurred.