COcommpeak
Webhook-Requests

Get all webhook requests

Changed on

List the callbacks your webhooks have sent: the payload, your endpoint's HTTP status and response, and the retries made. Use it to audit deliveries or debug an endpoint.

Pagination. page (1-based, default 1) and itemsPerPage (default 30, at most 1000). The response is a plain JSON array.

Filters. By webhook (webhook, webhook.name, webhook.url, webhook.trigger), by the status your endpoint returned (status), and by send time (sentAt[after], sentAt[before]). Sort with order[id].

Authentication: TextPeak API key in the Authorization header (see Authentication in the API Overview).

get/webhook_requests

Request

  • Base URL
    https://api.commpeak.com/textpeak
  • URL
    https://api.commpeak.com/textpeak/webhook_requests
  • Auth
    API key in header Authorization

Query parameters

pageinteger nullable

Page number (1-based).

itemsPerPageinteger nullable

Items per page, at most 1000.

order[id]'asc' | 'desc'

Sort by ID.

idinteger nullable

Exact delivery ID.

webhookinteger nullable

Only deliveries of this webhook ID.

webhook.namestring nullable

Webhook name contains this text.

webhook.urlstring nullable

Webhook URL contains this text.

webhook.triggerinteger nullable

Webhook trigger: 1 INCOMING_MESSAGE, 2 SHORT_URL_CLICK, 3 MESSAGE_DELIVERY, 4 EDR_INFORMATION, 5 CALL_PERMISSION.

webhook.trigger[]integer[] nullable

Any of these webhook triggers.

statusinteger nullable

HTTP status code your endpoint returned.

sentAt[before]string nullable

Sent on or before this time.

sentAt[after]string nullable

Sent on or after this time.

Response

Successful Response

idinteger required

Unique delivery identifier.

responsestring required

Response received from your endpoint (truncated).

requestunknown required
statusinteger required

HTTP status code your endpoint returned.

retriesinteger required

Retry attempts made.

sentAtstring required

When the callback was sent. Format YYYY-MM-DD HH:MM:SS.

Example response

[
  {
    "id": 9001,
    "request": {
      "message_uuid": "a61e5bfe-c82b-448a-815b-32de8bf22089",
      "status": "delivered"
    },
    "response": "OK",
    "retries": 0,
    "sentAt": "2026-03-19 10:15:13",
    "status": 200,
    "webhook": {
      "id": 3,
      "name": "Delivery receipts"
    }
  }
]

Changes