Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Webhooks

Update a webhook subscription

Updates the Webhook Subscription associated with the provided UUID.

📘 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

put/v1/webhook_subscriptions/{webhook_subscription_uuid}

Path parameters

webhook_subscription_uuidstring required

The webhook subscription UUID.

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

subscription_typesstring[] required

The types of events to subscribe to.

Response

successful

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.