Webhooks

Get Webhook Delivery

One delivery, with the JSON body that was sent.

API key access

Needs the admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

endpoint_idstring
Formatuuid
delivery_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/deliveries/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "endpoint_id": "e9ce0d4f-d433-423d-9497-4c000544106c",
  "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  "event_type": "call.completed",
  "status": "pending",
  "attempts": 0,
  "last_status_code": 0,
  "last_error": "string",
  "last_response": "string",
  "last_duration_ms": 0,
  "last_attempt_at": "2019-08-24T14:15:22Z",
  "next_attempt_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "replay_of": "eb051ed0-925f-449a-a6c5-0c118d499f91",
  "is_test": true,
  "created_at": "2019-08-24T14:15:22Z",
  "payload": {
    "property1": null,
    "property2": null
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}