Users Webhooks
Sent when data retrieval has completed for a user.
#Fully synced
The users.fully_synced webhook is sent when all data has been fully retrieved from all payroll accounts a user connected through Link.
When multiple accounts are connected:
- The webhook will only be sent if at least one account connection is successful.
- If a new account is connected (and its data fully retrieved) after the user's previously connected accounts were fully synced and the
users.fully_syncedwebhook was sent, this webhook will be sent again.
- #eventsarray of stringsrequired
users.fully_synced - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
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.
- #secretstringoptional
Optional secret used to verify webhooks.
- #eventstring
users.fully_synced - #namestring
Name used for the webhook subscription.
- #dataobject
- #userstring (uuid)
ID of the user.
- #resourceobject
- #idstring (uuid)
ID of the user.
- #accounts_connectedarray of strings
Accounts connected by the user that have fully synced.
Each account's
connection.statuswill either beconnectedorerror. - #items_connectedarray of strings
The Items through which the user connected their payroll accounts in Link.
- #employers_connectedarray of strings
Names of the employers associated with the Items.
- #external_metadataobject
Any
external_metadataattached to the user. - #external_idstring
The
external_idattached to the user, otherwisenull. - #created_atstring (datetime)
Timestamp (ISO 8601) when webhook subscription was created.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["users.fully_synced"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "users.fully_synced",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
6 "resource": {
7 "id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
8 "accounts_connected": [
9 "0185a8b8-60eb-80ca-7482-5f24504573f7",
10 "0187c66e-e7e5-811c-b006-2232f00f426a"
11 ],
12 "items_connected": [
13 "item_000000001",
14 "item_000000002"
15 ],
16 "employers_connected": [
17 "Whole Goods",
18 "Bullseye"
19 ],
20 "external_metadata": {},
21 "external_id": "July_Connection",
22 "created_at": "2023-04-27T07:02:01.279Z"
23 }
24 }
25}