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": [
    "shifts.partially_synced"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret",
  "config": {
    "days_synced": 60
  }
}
'
{
  "event": "shifts.partially_synced",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "available_from": "2023-01-02T0:000:00Z",
    "available_to": "2023-03-03T0:000:00Z",
    "available_count": 97,
    "days_synced": 60
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.argyle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

shifts.partially_synced

​
name
string
required

Your name 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.

​
secret
string

Optional secret used to verify webhooks.

​
config
object

days_synced: specifies how many days of synced shifts (starting from the date of the most recent shift) are needed to trigger the webhook.

Response

200 - application/json

Success

​
event
string

shifts.partially_synced

​
name
string

Name used for the webhook subscription.

​
data
object