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

Get a delivery

client.webhooks.deliveries.get(stringdeliveryID, DeliveryGetParams { teamId, webhookId } params, RequestOptionsoptions?): WebhookDeliveryDetail { attempt_history }
GET/v2/webhooks/{teamId}/{webhookId}/deliveries/{deliveryId}

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

ParametersExpand Collapse
deliveryID: string
formatuuid
params: DeliveryGetParams { teamId, webhookId }
teamId?: string
formatuuid
webhookId: string
formatuuid
ReturnsExpand Collapse
WebhookDeliveryDetail extends WebhookDelivery { created_at, delivery_id, status, 8 more } { attempt_history }

A delivery plus its full attempt timeline.

attempt_history?: Array<AttemptHistory>
attempt: number

1-based attempt number.

created_at: string
formatdate-time
status: "success" | "failed"
One of the following:
"success"
"failed"
error?: string | null

Failure reason, when status is failed.

request_body?: string | null

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

response_body?: string | null

Body returned by the endpoint; may be truncated.

status_code?: number | null

Get a delivery

import Micro from '@micro-so/sdk';

const client = new Micro({
  teamID: 'My Team ID',
  apiKey: process.env['MICRO_API_KEY'], // This is the default and can be omitted
});

const webhookDeliveryDetail = await client.webhooks.deliveries.get(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { webhookId: '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e' },
);

console.log(webhookDeliveryDetail);
{
  "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
    }
  ]
}