Webhooks
List Webhook Event Data
Returns the data records associated with a webhook event, paginated. The item shape depends on the event type (payroll, census, or update group).
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
Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer .
Path Parameters
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)$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
Maximum number of records to return
Required range:
1 <= x <= 4294967295Number of records to skip from the beginning
Required range:
0 <= x <= 4294967295Comma-separated list of fields to sort by. Prefix with - for descending order
Pattern:
^(-?\w{1,100})(?:,(-?\w{1,100})){0,2}$