Create Webhook

Creates a new webhook for the authenticated user's API key. The webhook will fire when the specified events occur or when any of the monitored fields change.

The monitorFields array is required when events includes employee.updated or employee_with_fields.updated. If events is omitted, it defaults to ['employee_with_fields.updated', 'employee_with_fields.deleted', 'employee_with_fields.created'], which means monitorFields is required by default. The format field is required.

The response includes a privateKey that can be used to verify the authenticity of incoming webhook payloads via HMAC-SHA256. This key is only returned at creation time and cannot be retrieved again.

For more details refer to the webhooks documentation, including guides for event-based and field-based webhooks.

For details on the payloads sent by each event, see the event reference:

Language
Credentials
:
URL
Response
Click Try It! to start a request and see the response here!