Help Center/ KooMessage/ User Guide/ Using the Email Message Service/ Receiving Receipts Through the Webhook URL
Updated on 2024-12-12 GMT+08:00
View PDF
Share

Receiving Receipts Through the Webhook URL

You need to provide the webhook URL (callback URL) to operations personnel. The operations personnel configure the address in the system. After you send an email, KooMessage automatically sends the recipient information to you, and you automatically receive the receipt information.

Callback URL

The callback address must be in the following format:

POST https://{customerDomain}/{addressPath}

{customerDomain} indicates the domain name of the user, and {addressPath} indicates the path in the user receipt address. Example:

POST https://{customerDomain}/customer/webhook/path

Receipt Information

Table 1 Receipt parameters

Parameter

Type

Description

messageId

String

Message ID.

status

String

Message receiving status of the recipient.

  • PENDING
  • UNDELIVERABL
  • DELIVERED
  • EXPIRED
  • REJECTED

to

String

Recipient address.

sendAt

String

Sending time. The format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.

doneAt

String

Delivery time. The format is yyyy-MM-dd'T'HH:mm:ss.SSSZ.

Example receipt:

{
        "messageId": "hgtesn8bcmc71pujp92d",
        "status": "DELIVERED",
        "to": "example@ex.com",
        "sendAt": " 2024-09-08T05:27:57.628Z",
        "doneAt": "2024-09-08T05:27:57.628Z "
}