Skip to main content
POST
Example subscription

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