Skip to main content
GET
/
v1
/
webhooks
/
{webhook_id}
/
deliveries
List Delivery Attempts
curl --request GET \
  --url https://karibu.briq.tz/v1/webhooks/{webhook_id}/deliveries \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "event_id": "<string>",
      "webhook_id": "<string>",
      "service_type": "<string>",
      "event_name": "<string>",
      "attempt_count": 123,
      "max_attempts": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "app_id": "<string>",
      "last_status_code": 123,
      "last_error": "<string>",
      "next_attempt_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

X-API-Key
string
header
required

Headers

X-API-Key
string
required

Path Parameters

webhook_id
string
required

Query Parameters

status
enum<string> | null

Filter by delivery status.

Available options:
pending,
delivered,
failed,
exhausted
event_name
string | null

Filter by event name, e.g. briq.message.delivered.

from_created_at
string<date-time> | null
to_created_at
string<date-time> | null
message_id
string | null
limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

Paginated list of webhook delivery attempts.

items
WebhookDeliveryOut · object[]
required
total
integer
required

Total count matching the filters.

limit
integer
required
offset
integer
required