AgentMessage
Webhooks

Get a webhook delivery attempt

GET
/v1/webhooks/deliveries/{id}

Read a single delivery attempt by id. Requests for an attempt outside your organization return 404 so delivery ids cannot be enumerated.

Requires the webhooks:read scope.

AuthorizationBearer <token>

Authenticate by sending your API key as a bearer token: Authorization: Bearer am_live_.... Every request is automatically scoped to the organization that owns the key and to the scopes granted to that key.

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/webhooks/deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",
  "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  "event_type": "wallet.balance_low",
  "url": "http://example.com",
  "attempt": 1,
  "outcome": "success",
  "response_status": 0,
  "response_time_ms": 0,
  "request_body_sha256": "string",
  "request_body_bytes": 0,
  "response_body_excerpt": "string",
  "request_headers": {
    "property1": "string",
    "property2": "string"
  },
  "error": "string",
  "occurred_at": "2019-08-24T14:15:22Z"
}
{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "authentication failed",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}
{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "missing required scope",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "not found",
    "request_id": "01JTBQH2FZ8K1RXC0WJ4Z9P3VM"
  }
}