Skip to main content
GET
/
v1
/
webhooks
/
{id}
/
events
List Webhook Deliveries
curl --request GET \
  --url https://api.anchorbrowser.io/v1/webhooks/{id}/events \
  --header 'anchor-api-key: <api-key>'
{
  "events": [
    {
      "id": "<string>",
      "external_event_id": "evt_56a4c6e7f11e4b44eafce28a",
      "attempt": 1,
      "response_status": 123,
      "error_message": "<string>",
      "scheduled_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
anchor-api-key
string
header
required

API key passed in the header

Path Parameters

​
id
string
required

Webhook id.

Query Parameters

​
limit
integer
default:25

Page size, 1–100. Defaults to 25.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of rows to skip from the beginning of the result set.

Required range: x >= 0
​
status
enum<string>

Filter by delivery status.

Available options:
pending,
in_flight,
succeeded,
failed,
dead
​
event_type
enum<string>

Filter by event type. Catalog of webhook event types Anchor can deliver. Adding a new event type is a coordinated change between session-manager (publisher), webhook-dispatcher (consumer), and the dashboard.

Available options:
task.completed,
task.failed,
task.cancelled,
task.healed,
session.completed,
session.failed,
session.recording.ready,
batch.completed,
batch.failed,
intervention.requested,
intervention.resolved,
identity.authenticated,
identity.authentication_failed
​
since
string<date-time>

Only include deliveries scheduled at or after this ISO 8601 timestamp.

​
until
string<date-time>

Only include deliveries scheduled at or before this ISO 8601 timestamp.

Response

Page of delivery rows plus pagination metadata.

​
events
object[]
required
​
pagination
object
required