Skip to main content
POST
Example subscription
Sent when paystubs are added or updated. If you need to access to paystubs as soon as they are available:
  • The paystubs.partially_synced webhook is sent when paystubs going back a specified number of days prior (starting from the date when the account was added) have been retrieved during initial data retrieval for a newly connected account.
  • The paystubs.fully_synced webhook is sent when all paystubs have been retrieved during initial data retrieval for a newly connected account.

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json

Request body for subscribing to the paystubs.added webhook.

events
enum<string>[]
required

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

Available options:
paystubs.added
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.added
name
string

The name of the webhook subscription.

data
object