SmsGetWebhookEvents

GET sms/webhookEvents/list

Returns the raw provider events the module received, with the payload and what the module did with each one. This is the audit trail for "the operator says the message was delivered".

Every event is stored, including ignored and unverified ones. Without that record a signature mismatch or a duplicate would be invisible, and the conversation with the provider would come down to guesses.

Access Control

Allowed role: admin.

Request

RESTTCPSDK

GET request

GET https://{broker_domain}/sms/webhookEvents/list?limit=50&orderBy=%5B%22id%22%2C%22DESC%22%5D&where=%7B%22result%22%3A%22UNVERIFIED%22%7D
Authorization: <JWT_TOKEN>

{
  "command": "SmsGetWebhookEvents",
  "extID": "1",
  "data": {
    "limit": 50,
    "orderBy": [
      "id",
      "DESC"
    ],
    "where": {
      "result": "UNVERIFIED"
    }
  }
}

const res = await platform.SmsGetWebhookEvents({
  limit: 50,
  orderBy: [
    "id",
    "DESC"
  ],
  where: {
    result: "UNVERIFIED"
  }
});

Request Data

Field	Type	Required	Description
limit	int	No	Page size, 1..1000, default 100
offset	int	No	Rows to skip
orderBy	array	No	Sorting, for example ["id", "DESC"]
count	array	No	Row count aggregate, ["id"]
where	object	No	Filters, see Table filter syntax

Behavior

• Events are deduplicated by the provider event id: a repeated delivery is stored once with result: "DUPLICATE" and does not change the message again.
• Old events are purged by a cron according to the retention setting, so the table cannot grow without bound.

Response Data

Results: PROCESSED, DUPLICATE, IGNORED, UNVERIFIED, NO_MESSAGE, ERROR. NO_MESSAGE means the event referenced a message this brand does not have.

{
  "rows": [
    {
      "id": 5121,
      "webhookId": 2,
      "webhookUuid": "9f2a1c7d4b6e",
      "providerEventId": "EV-99213-1",
      "result": "PROCESSED",
      "smsId": 812,
      "error": null,
      "payload": { "MessageSid": "SM9f2a1c", "MessageStatus": "delivered" },
      "createdAt": "2026-08-24 13:32:47"
    }
  ]
}

Errors

Code	Error	Description
401	PERMISSION_DENIED	Not an admin session