Skip to content
Micro micro
Go to Micro
API Reference
Webhooks
Deliveries

List webhook deliveries

GET/v2/webhooks/{teamId}/{webhookId}/deliveries

An endpoint’s deliveries, newest first, with optional status / type / time-range filters and cursor pagination.

Path ParametersExpand Collapse
teamId: optional string
formatuuid
webhookId: string
formatuuid
Query ParametersExpand Collapse
after: optional string

Only deliveries at or after this ISO-8601 timestamp.

formatdate-time
before: optional string

Only deliveries at or before this ISO-8601 timestamp.

formatdate-time
cursor: optional string

Opaque cursor from a previous response’s next_cursor.

limit: optional number

Page size (1–100, default 25).

minimum1
maximum100
status: optional "success" or "failed"

Filter by outcome.

One of the following:
"success"
"failed"
type: optional "delivery" or "verification" or "all"

Filter by run type. Defaults to delivery (event deliveries). Pass all to include verification handshakes.

One of the following:
"delivery"
"verification"
"all"
ReturnsExpand Collapse
data: array of WebhookDelivery { created_at, delivery_id, status, 8 more }
created_at: string
formatdate-time
delivery_id: string
formatuuid
status: "success" or "failed"
One of the following:
"success"
"failed"
type: "delivery" or "verification"
One of the following:
"delivery"
"verification"
webhook_id: string
formatuuid
attempts: optional number

Number of attempts made so far (including async retries).

event: optional string

Event name (e.g. webhook.test); verification for handshake runs.

status_code: optional number

HTTP status of the latest attempt; null on a transport error.

team_id: optional string
formatuuid
updated_at: optional string
formatdate-time
url: optional string
next_cursor: optional string

Pass as cursor to fetch the next page; null when there are no more.

List webhook deliveries

curl https://developers.micro.so/v2/webhooks/$TEAM_ID/$WEBHOOK_ID/deliveries \
    -H "x-api-key: $MICRO_API_KEY"
{
  "data": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "delivery_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": "success",
      "type": "delivery",
      "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "attempts": 0,
      "event": "event",
      "status_code": 0,
      "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "url": "url"
    }
  ],
  "next_cursor": "next_cursor"
}
Returns Examples
{
  "data": [
    {
      "created_at": "2019-12-27T18:11:19.117Z",
      "delivery_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "status": "success",
      "type": "delivery",
      "webhook_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "attempts": 0,
      "event": "event",
      "status_code": 0,
      "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "2019-12-27T18:11:19.117Z",
      "url": "url"
    }
  ],
  "next_cursor": "next_cursor"
}