Skip to main content
GET
List data for a webhook event
The item shape depends on the event’s eventType:
Census events (EMPLOYEE_CENSUS_HIRED, EMPLOYEE_CENSUS_UPDATED, EMPLOYEE_CENSUS_TERMINATED) are batched per run rather than per employee, so a single event can have many data rows — one per affected employee.

Authorizations

Authorization
string
header
required

Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer .

Path Parameters

webhook_subscription_id
string<uuid>
required

Unique identifier of the webhook subscription

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
webhook_event_id
string<uuid>
required

Unique identifier of the webhook event

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

limit
integer

Maximum number of records to return

Required range: 1 <= x <= 4294967295
offset
integer

Number of records to skip from the beginning

Required range: 0 <= x <= 4294967295
sort
string

Comma-separated list of fields to sort by. Prefix with - for descending order

Pattern: ^(-?\w{1,100})(?:,(-?\w{1,100})){0,2}$

Response

Webhook event data retrieved successfully

data
object[]
required
meta
object
required