GuidesAPI ReferenceChangelog
Log In
API Reference

Create a webhook subscription

post
https://api.gusto-demo.com/v1/webhook_subscriptions

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The URL where webhook events will be POSTed.

subscription_types
array of strings
required

The types of events to subscribe to.

subscription_types*
Headers
string
enum
Defaults to 2026-02-01

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

Allowed:
Responses

Updated 22 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 22 days ago