Skip to main content
GET
List webhook events

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Query Parameters

workspace_id
string

Only this workspace's events. A wks_ id; integer workspace ids are still accepted.

Example:

"wks_01k6a2r9s8x7c2dvq3m5n6p4ab"

type
string

Only events of this type.

Example:

"meeting.finished"

endpoint_id
string

Only events delivered to this endpoint.

Example:

"whe_01k6d4a1b2c3d4e5f6g7h8j9km"

delivery_status
enum<string>

Only events with a delivery in this state, to endpoint_id when given.

  • pending: not answered yet.
  • succeeded: your receiver returned 2xx.
  • failed: its last attempt failed; it is retried until it succeeds or 21 attempts are used.
  • cancelled: the endpoint was disabled, stopped receiving the event, or could not be sent to.
Available options:
pending,
succeeded,
failed,
cancelled
created_after
string<date-time>

Only events at or after this ISO 8601 time.

created_before
string<date-time>

Only events before this ISO 8601 time.

limit
integer
default:25

Page size, 1 to 100.

Required range: 1 <= x <= 100
cursor
string

Opaque. Follow _links.next.url rather than building it.

Response

One page of events, without their payloads.

object
string

Always list.

data
object[]

The events on this page.

has_more
boolean

Whether more results follow this page.

Empty on the last page.