Legacy Docs

Users Webhooks

Sent when data retrieval has completed for a user.

#Fully synced

post/v2/webhooks

The users.fully_synced webhook is sent when all data has been fully retrieved for every payroll account the user connected through Link.

When multiple accounts are connected, the webhook will only be sent if at least one account connection is successful.

Request body
  • eventsarray of strings
    required

    users.fully_synced

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    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.

  • secretstring
    optional

    Optional secret used to verify webhooks.

Webhook message
  • eventstring

    users.fully_synced

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • userstring

    ID of the user.

  • resourceobject

  • userstring

    ID of the user

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

Example Subscription
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     }'
Example Webhook
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      "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
8      "items_connected": [
9        "item_000000001",
10        "item_000000002"
11      ],
12      "employers_connected": [
13        "Whole Goods",
14        "Bullseye"
15      ]
16    }
17  }
18}