Skip to content
Go to Micro

Get a delivery

webhooks.deliveries.get(strdelivery_id, DeliveryGetParams**kwargs) -> WebhookDeliveryDetail
GET/v2/webhooks/{teamId}/{webhookId}/deliveries/{deliveryId}

A single delivery plus its full attempt timeline (including async retries).

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
webhook_id: str
formatuuid
delivery_id: str
formatuuid
ReturnsExpand Collapse
class WebhookDeliveryDetail:

A delivery plus its full attempt timeline.

attempt_history: Optional[List[WebhookDeliveryDetailAttemptHistory]]
attempt: int

1-based attempt number.

created_at: datetime
formatdate-time
status: Literal["success", "failed"]
One of the following:
"success"
"failed"
error: Optional[str]

Failure reason, when status is failed.

request_body: Optional[str]

Body sent to the endpoint (delivery only); may be truncated.

response_body: Optional[str]

Body returned by the endpoint; may be truncated.

status_code: Optional[int]

Get a delivery

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
)
webhook_delivery_detail = client.webhooks.deliveries.get(
    delivery_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    webhook_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(webhook_delivery_detail)
{
  "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",
  "attempt_history": [
    {
      "attempt": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "status": "success",
      "error": "error",
      "request_body": "request_body",
      "response_body": "response_body",
      "status_code": 0
    }
  ]
}
Returns Examples
{
  "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",
  "attempt_history": [
    {
      "attempt": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "status": "success",
      "error": "error",
      "request_body": "request_body",
      "response_body": "response_body",
      "status_code": 0
    }
  ]
}