Skip to main content
GET
/
webhook_events
/
{webhook_event_id}
Get webhook event
curl --request GET \
  --url https://api.withorb.com/v1/webhook_events/{webhook_event_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_delivered": true,
  "payload": {},
  "delivery_attempts": [
    {
      "id": "<string>",
      "endpoint_url": "<string>",
      "is_success": true,
      "response_status_code": 123,
      "elapsed_ms": 123,
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
webhook_event_id
string
required

Response

OK

A webhook event that was generated by Orb. This resource allows you to inspect webhook payloads and their delivery status, which is useful for debugging failed webhook deliveries or re-processing events that failed to deliver due to an outage on your end.

​
id
string
required

The unique identifier for the webhook event.

​
type
string
required

The type of webhook event (e.g., 'invoice.created', 'customer.updated').

​
created_at
string<date-time>
required

The time the webhook event was created.

​
is_delivered
boolean
required

Whether the webhook event has been successfully delivered to at least one endpoint.

​
payload
Payload · object
required

The webhook body. Always includes id, type, and created_at. When include_payload=true (the default), also includes the full event properties.

​
delivery_attempts
WebhookDeliveryAttemptResource · object[]
required

The list of delivery attempts for this webhook event across all configured endpoints.