Skip to main content
POST
Create a webhook subscription
The signingSecret in the response is shown only once. Store it securely and use it to verify every delivery. The path must be an https URL.

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,
PAYROLL_UPDATED,
UPDATE_GROUP_PROCESSED
path
string<uri>
required

Destination URL to receive webhook notifications. Must use https.

Response

Webhook subscription created successfully

webhookSubscriptionId
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)$
signingSecret
string
required

HMAC-SHA256 key for verifying deliveries (Standard Webhooks, whsec_ prefixed base64). Shown only in this response; it cannot be retrieved again.