Skip to main content
POST
Create webhook endpoint

Authorizations

Authorization
string
header
required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type
enum<string>
required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:
CLIENT_ORG_ADMIN,
PAYROLL_ADMIN,
FINANCE_ADMIN,
TOKU_ADMIN

Body

application/json
url
string<uri>
required

Destination webhook URL

events
enum<string>[]
required

Subscribed webhook events

Webhook event type emitted by the partner-facing API.

Available options:
grant.created,
grant.terminated,
grant.termination_reverted,
distribution.schedule_approved,
distribution.settlement_completed,
employee.onboarded,
employee.offboarded,
payroll_run.created,
payroll_run.approved,
payroll_run.completed,
payslip.generated,
payment.initiated,
payment.completed,
contractor.invoice_submitted,
time_off.requested,
time_off.status_changed

Response

Successful response

endpoint
object
required