Skip to content
/Events

Events

API for reading webhook event history

Operations

List events

Request

List webhook event history in ascending created_at order. To avoid advancing cursors past rows from still-open transactions, events are withheld from this endpoint until they are at least 30 seconds old. Narrow the feed with either type (exact event types) or object (every event for an object family); supplying both returns a 400. Cursors are filter-agnostic, so changing filters mid-pagination yields a different slice of history.

Security
form_session or user_session or component_session or component_token or api_token
Query
cursorstring(EventCursor)

Opaque pagination cursor returned by the events list endpoint.

limitstring(between(1, 1000))

a number between 1 and 1000

created_at_gtstring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

created_at_ltstring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

typestring

Comma-separated list of event types to return, e.g. job.created,job.updated. Cannot be combined with object.

objectstring

Comma-separated list of object families to return every event for, e.g. job returns job.created, job.updated, and job.deleted. Cannot be combined with type.

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/events?cursor=eyJjcmVhdGVkX2F0IjoiMjAyNi0wNi0yNVQyMDoxMjozNC41NjdaIiwiaWQiOjEyMzQ1fQ&limit=string&created_at_gt=string&created_at_lt=string&type=job.created&object=job' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

EventsList

Bodyapplication/json
dataArray of objects(Event)required
next_cursorEventCursor (string) or nullrequired
Any of:

Opaque pagination cursor returned by the events list endpoint.

string(EventCursor)
has_morebooleanrequired
Response
{
  "data": [
    { … }
  ],
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNi0yNVQyMDoxMjozNC41NjdaIiwiaWQiOjEyMzQ1fQ",
  "has_more": true
}