Skip to main content
POST
/
v2
/
webhooks
Example subscription
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "paystubs.partially_synced"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret",
  "config": {
    "days_synced": 60
  }
}
'
{
  "name": "<string>",
  "data": {
    "account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "available_from": "2023-11-07T05:31:56Z",
    "available_to": "2023-11-07T05:31:56Z",
    "available_count": 123,
    "days_synced": 123
  }
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json

Request body for subscribing to the paystubs.partially_synced webhook.

​
events
enum<string>[]
required

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

Available options:
paystubs.partially_synced
​
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.

​
config
object

"days_synced": <Integer> specifies how many days of synced paystubs (starting from the date of the most recent paystub) are needed to trigger the webhook. specifies how many days of synced paystubs are needed to trigger the webhook.

Response

Successful subscription

​
event
enum<string>

The type of event being triggered.

Available options:
paystubs.partially_synced
​
name
string

The name of the webhook subscription.

​
data
object