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

List webhook deliveries

webhooks.deliveries.list(strwebhook_id, DeliveryListParams**kwargs) -> DeliveryListResponse
GET/v2/webhooks/{teamId}/{webhookId}/deliveries

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

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
webhook_id: str
formatuuid
after: Optional[Union[str, datetime]]

Only deliveries at or after this ISO-8601 timestamp.

formatdate-time
before: Optional[Union[str, datetime]]

Only deliveries at or before this ISO-8601 timestamp.

formatdate-time
cursor: Optional[str]

Opaque cursor from a previous response’s next_cursor.

limit: Optional[int]

Page size (1–100, default 25).

minimum1
maximum100
status: Optional[Literal["success", "failed"]]

Filter by outcome.

One of the following:
"success"
"failed"
type: Optional[Literal["delivery", "verification", "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
class DeliveryListResponse: …
data: List[WebhookDelivery]
created_at: datetime
formatdate-time
delivery_id: str
formatuuid
status: Literal["success", "failed"]
One of the following:
"success"
"failed"
type: Literal["delivery", "verification"]
One of the following:
"delivery"
"verification"
webhook_id: str
formatuuid
attempts: Optional[int]

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

event: Optional[str]

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

status_code: Optional[int]

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

team_id: Optional[str]
formatuuid
updated_at: Optional[datetime]
formatdate-time
url: Optional[str]
next_cursor: Optional[str]

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

List webhook deliveries

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
deliveries = client.webhooks.deliveries.list(
    webhook_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(deliveries.data)
{
  "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"
}