Skip to main content
POST
Example subscription
By default, the historical period is 30 days and starts from the date when the account was added.
You can subscribe to this webhook multiple times with different numbers of specified days.
  • This webhook is sent only during initial data retrieval (not ongoing refresh).
  • If the number of shifts for an account is small and captured completely with only one data pull, this webhook will not be sent. Instead the shifts.fully_synced webhook will be sent.

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