Get a webhook subscription

GET {{baseUrl}}/v1/webhook_subscriptions/:webhook_subscription_uuid

Returns the Webhook Subscription associated with the provided UUID.

📘 Token Authentication

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

scope: webhook_subscriptions:read

HEADERS

KeyDatatypeRequiredDescription
X-Gusto-API-VersionstringDetermines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Acceptstring

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