Create a webhook subscription

POST {{baseUrl}}/v1/webhook_subscriptions

Create a webhook subscription to receive events of the specified subscription_types whenever there is a state change.

📘 Token Authentication

This endpoint uses the organization level api token and the Token scheme with HTTP Authorization header.

scope: webhook_subscriptions:write

Request Body

{"url"=>"<string>", "subscription_types"=>["<string>", "<string>"]}

HEADERS

RESPONSES

status: Created

{"uuid":"c5fdae57-5483-4529-9aae-f0edceed92d4","url":"https://the-partner-app.com/subscriber","status":"verified","subscription_types":["BankAccount","Company","CompanyBenefit","Contractor","ContractorPayment","Employee","EmployeeBenefit","EmployeeJobCompensation","ExternalPayroll","Form","Location","Notification","Payroll","PaySchedule","Signatory"]}