Get a Webhook Delivery

GET /webhook_deliveries/{webhook_delivery_id}

Retrieve an existing Webhook Delivery

Headers

  • Authorization string Required

    Authorize your API calls with an Arta API token

Path parameters

Responses

  • 200 application/json

    Successful Webhook Delivery response

    Hide headers attributes Show headers attributes
    Hide response attributes Show response attributes object
    • next_retry string | null

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

    • id string

      The string ID for this webhook delivery resource

    • A stringified JSON representation of the data Arta sent to your endpoint

    • The ID of the resource that triggered the webhook event

    • The type of resource that triggered the webhook event

      Values are ping, request, or shipment.

    • A string representation of the response body Arta received from your endpoint

    • The numerical HTTP status code Arta received from your endpoint

    • 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

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

  • 404 application/json

    Resource Not Found

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object

    Basic Error

GET /webhook_deliveries/{webhook_delivery_id}
curl \
 -X GET https://api.arta.io/webhook_deliveries/{webhook_delivery_id} \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y"
Response examples (200)
{
  "id": "5b6e1621-454f-4f18-aecf-87192406effe",
  "type": "ping",
  "status": "delivered",
  "created_at": "2021-10-27T16:48:38.657228",
  "next_retry": null,
  "webhook_id": 432672,
  "resource_id": "9c67b26c-6b5d-4e19-a703-f7356f82d7e0",
  "webhook_url": "https://hooks.mydomain.xyz/arta",
  "request_body": "{\\\"data\\\":{\\\"id\\\":432672},\\\"object\\\":\\\"webhook\\\",\\\"type\\\":\\\"ping\\\"}",
  "resource_type": "request",
  "response_body": "{\\\"received\\\": true}",
  "response_status_code": 202
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}