Skip to main content
POST
Example subscription

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json

Request body for subscribing to the paystubs.updated webhook.

events
enum<string>[]
required

List of events to subscribe to. Must include paystubs.updated. Value is paystubs.updated

Available options:
paystubs.updated
name
string
required

Your name for the webhook subscription. Name used for the webhook subscription.

url
string
required

Where you want to receive webhook delivery. This can be either a backend URL that you manage, or a URL provided by a webhook management service. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form. URL where you want to receive webhook delivery.

secret
string | null

Optional secret used to verify webhooks. Secret used to verify webhooks.

Response

Successful subscription

event
enum<string>

The type of event being triggered.

Available options:
paystubs.updated
name
string

The name of the webhook subscription.

data
object