Verify the webhook subscription

PUT {{baseUrl}}/v1/webhook_subscriptions/:webhook_subscription_uuid/verify

When a webhook subscription is created, a verification_token is POSTed to the registered webhook subscription URL. This verify endpoint needs to be called with verification_token before webhook events can be sent to the registered webhook URL.

Use the /v1/webhooksubscriptions/{webhooksubscriptionuuid}/requestverificationtoken API to resend the `verificationtoken` to the Subscriber.

📘 Token Authentication

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

scope: webhook_subscriptions:write

Request Body

{"verification_token"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"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"]}