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.added"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret"
}
'
{
  "event": "shifts.added",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "available_from": "2016-04-16T05:32:41Z",
    "available_to": "2023-03-03T00:00:00Z",
    "available_count": 412,
    "added_count": 6,
    "added_from": "2023-03-02T00:00:00Z",
    "added_to": "2023-03-03T00:00:00Z"
  }
}
Sent when shifts are added, updated, or removed. If you need to access to shift data as soon as it is available:
  • The shifts.partially_synced webhook is sent when shifts 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 shifts.fully_synced webhook is sent when all shifts have been retrieved during initial data retrieval for a newly connected account.
Because some accounts can contain hundreds of shifts, we recommend subscribing to the shifts.partially_synced webhook when especially time-sensitive. The shifts.fully_synced webhook will only be sent when all shift data has been retrieved, which may take up to several hours in these cases.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

shifts.added

​
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.

Response

200 - application/json

Success

​
event
string

shifts.added

​
name
string

Name used for the webhook subscription.

​
data
object