Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

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

Body

application/json

Webhook subscription creation request

event_types
enum<string>[]
required

The webhook event types to subscribe to

Minimum array length: 1
Available options:
EMPLOYEE_CENSUS_HIRED,
EMPLOYEE_CENSUS_TERMINATED,
EMPLOYEE_CENSUS_UPDATED,
PAYROLL_PROCESSED,
UPDATE_GROUP_PROCESSED
path
string<uri>
required

Destination URL to receive webhook notifications

Response

Webhook subscription created successfully