List Webhook Deliveries

GET /webhook_deliveries

Retrieve a paginated collection of Webhook Deliveries belonging to your Organization

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Query parameters

  • page integer

    Page number of the results to fetch.

    Default value is 1.

  • page_size integer

    Results per page (max 50)

    Default value is 20.

Responses

  • 200 application/json

    A collection of Webhook Deliveries

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • items array[object]
      Hide items attributes Show items attributes object
      • created_at string
      • id string

        The string ID for this webhook delivery resource

      • next_retry string | null

        The UTC timestamp describing when a follow up webhook delivery event will be attempted if this one has failed

      • resource_id string

        The ID of the resource that triggered the webhook event

      • resource_type string

        The type of resource that triggered the webhook event

        Values are ping, request, or shipment.

      • response_status_code number
      • status string

        The status of the webhook delivery event

        Values are delivered or failed.

      • type string

        The type of webhook delivery sent to your endpoint

        Values are ping, request.created, request.shared, request.status.updated, request.updated, shipment.created, shipment.eei_form_status.updated, shipment.exceptions.updated, shipment.schedule.updated, shipment.status.updated, shipment.tracking.updated, shipment.updated, shipment_exception.created, or shipment_exception.status.updated.

      • webhook_id integer

        The ID belonging to your webhook endpoint in Arta's system

      • webhook_url string

        The URL belonging to your webhook endpoint in Arta's system at the time Arta attempted delivery of the webhook event

    • metadata object

      Additional properties are allowed.

      Hide metadata attributes Show metadata attributes object
GET /webhook_deliveries 
curl \
 -X GET https://api.arta.io/webhook_deliveries \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200) 
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "items": [
    {
      "created_at": "2021-10-27T16:48:38.657228",
      "id": "5b6e1621-454f-4f18-aecf-87192406effe",
      "next_retry": "string",
      "resource_id": "9c67b26c-6b5d-4e19-a703-f7356f82d7e0",
      "resource_type": "request",
      "response_status_code": 202,
      "status": "delivered",
      "type": "ping",
      "webhook_id": 432672,
      "webhook_url": "https://hooks.mydomain.xyz/arta"
    }
  ],
  "metadata": {
    "page": 1,
    "page_size": 20,
    "total_count": 1
  }
}