Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Webhooks

Create a webhook subscription

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

📘 System Access Authentication

This endpoint uses the Bearer Auth scheme with the system-level access token in the HTTP Authorization header

scope: webhook_subscriptions:write

post/v1/webhook_subscriptions

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Request body

urlstring required

The URL where webhook events will be POSTed.

subscription_typesstring[] required

The types of events to subscribe to.

Response

created

uuidstring required

The UUID of the webhook subscription.

urlstring

The webhook subscriber URL. Updates will be POSTed to this URL.

status'pending' | 'verified' | 'removed' | 'unreachable'

The status of the webhook subscription.

subscription_typesstring[]

Receive updates for these types.