Skip to main content
GET
/
webhook_events
List webhook events
curl --request GET \
  --url https://api.withorb.com/v1/webhook_events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "pagination_metadata": {
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:20

The number of items to fetch. Defaults to 20.

Required range: 1 <= x <= 100
​
cursor
string | null

Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.

​
delivery_success
boolean | null

Filter by delivery status. If false, returns events that have not been successfully delivered.

​
event_type
string | null

Filter by webhook event type (e.g., 'invoice.created').

​
include_payload
boolean
default:true

Whether to include the full event properties in the payload. When false, payload contains only id, type, and created_at for faster pagination.

​
created_at[gte]
string<date-time> | null
​
created_at[gt]
string<date-time> | null
​
created_at[lt]
string<date-time> | null
​
created_at[lte]
string<date-time> | null

Response

OK

​
data
WebhookEventResource · object[]
required
​
pagination_metadata
PaginationMetadata · object
required