Skip to main content
POST
Example subscription
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