Skip to main content
GET
/
webhooks
/
{webhookId}
/
deliveries
Get webhook deliveries
curl --request GET \
  --url https://api.lettermint.co/v1/webhooks/{webhookId}/deliveries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "webhook_id": "<string>",
      "event_type": "message.created",
      "status": "pending",
      "attempt_number": 123,
      "http_status_code": 123,
      "duration_ms": 123,
      "delivered_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "path": "<string>",
  "per_page": 1,
  "next_cursor": "<string>",
  "next_page_url": "<string>",
  "prev_cursor": "<string>",
  "prev_page_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Team API token. Find this in your team settings.

Path Parameters

​
webhookId
string
required

Query Parameters

​
sort
string
default:-created_at

Available sorts are created_at, attempt_number. You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -created_at.

​
filter[status]
enum<string>

Filter by delivery status

Available options:
pending,
success,
failed,
client_error,
server_error,
timeout
​
filter[event_type]
string

Filter by event type

​
filter[from_date]
string

Filter deliveries from this date (Y-m-d format)

​
filter[to_date]
string

Filter deliveries to this date (Y-m-d format)

Response

200 - application/json

Paginated set of WebhookDeliveryListData

​
data
WebhookDeliveryListData · object[]
required
​
path
string | null
required

Base path for paginator generated URLs.

​
per_page
integer
required

Number of items shown per page.

Required range: x >= 0
​
next_cursor
string | null
required

The "cursor" that points to the next set of items.

​
next_page_url
string<uri> | null
required
​
prev_cursor
string | null
required

The "cursor" that points to the previous set of items.

​
prev_page_url
string<uri> | null
required