Event types

List of supported event types and their payload.

Each event has an unique id, which can be used to identify it and avoid duplicates handling.

SMS

`sms.sent`

Occurs whenever the sms has been sent to the carrier

Sample Response Body


{
  "id": "feafebf4-936f-413a-9a67-97018d123a4b", // Unique id of the event
  "event": "sms.sent",
  "eventTimestamp": 1753020826588, // Moment when the event was triggered in milliseconds since epoch
  "data": {
    "smsId": "00fa966b-0e28-475b-9fd2-939f4070a289",
    "senderId": "LOL", // You can learn more about senderId
    "destinationPhoneNumber": "+3311223345",
    "messageRequestTimestamp": 1753020825312 // Moment when the sending of the sms was requested in milliseconds since epoch
  }
}

`sms.delivered`

Occurs whenever the sms has been delivered to the recipient

Sample Response Body


{
  "id": "c57ef75e-cb08-482e-a7b6-60e154baa7f7", // Unique id of the event
  "event": "sms.received",
  "eventTimestamp": 1753020829338, // Moment when the event was triggered in milliseconds since epoch
  "data": {
    "smsId": "00fa966b-0e28-475b-9fd2-939f4070a289",
    "senderId": "LOL",
    "destinationPhoneNumber": "+3311223345",
    "messageRequestTimestamp": 1753020825312 // Moment when the sending of the sms was requested in milliseconds since epoch
  }
}

`sms.failed`

Occurs whenever the sms has failed to be delivered to the recipient

Sample Response Body


{
  "id": "741b4cea-e60d-4554-a35c-865203c8c32d", // Unique id of the event
  "event": "sms.failed",
  "eventTimestamp": 1753037219937, // Moment when the event was triggered in milliseconds since epoch
  "data": {
    "smsId": "c5705ba1-2fdb-405f-83a2-6199d3eec946",
    "senderId": "LOL",
    "destinationPhoneNumber": "+3311223345",
    "messageRequestTimestamp": 1753037218587 // Moment when the sending of the sms was requested in milliseconds since epoch
  }
}

Have feedback, found a bug, or want to suggest a feature?

Open an issue on GitHub
Or chat with us directly on Discord — we’re happy to help!