>  Switch To Link 5 and API v2 Documentation

Users Webhooks

Learn about users webhooks.

API integrations should be designed to leverage Argyle's webhooks so you are notified in real-time when each data resource is available for retrieval. Webhooks can also return full resources when they become available. See the rest of our Webhooks Reference for a complete list.

#Fully synced

post/v1/webhooks

Implement the users.fully_synced webhook to be notified when data retrieval has completed for all accounts successfully connected by a user.

  • Once the users.fully_synced webhook is received, data and documents for all accounts successfully connected by a user are fully available via Console or the API.
  • If the user connects multiple payroll accounts, the users.fully_synced webhook will only be sent if at least one of the accounts has successfully connected. The webhook will not be sent if all accounts fail to connect.
  • The users.fully_synced webhook is not sent immediately upon successful account connection by a user. Data is pulled from payroll platforms and delivered gradually.
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 (uuid)

    ID of the user.

  • #
    resourceobject

  • #
    idstring (uuid)

    ID of the user.

  • #
    data_providers_connectedarray of strings

    The Link items through which the user connected their payroll accounts in Link.

  • #
    employers_connectedarray of strings

    Names of the employers associated with the Link items.

  • #
    external_metadataobject

    Any external_metadata attached to the user.

  • #
    created_atstring (timestamp)

    Timestamp when the webhook was created. Timestamps follow the ISO 8601 standard.

Example Subscription
1curl --request POST \
2     --url https://api.argyle.com/v1/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 your webhook>",
4  "data": {
5    "user": "01838ad1-b6bd-22f8-22f1-d3f5b3953484",
6    "resource": {
7      "id": "01838ad1-b6bd-22f8-22f1-d3f5b3953484",
8      "data_providers_connected": [
9        "mypayroll_platform"
10      ],
11      "employers_connected": [
12        "Whole Goods",
13        "SprintCar"
14      ],
15      "external_metadata": {},
16      "created_at": "2022-09-29T19:55:43.166095Z"
17    }
18  }
19}
Updating Argyle status...
© 2024 Argyle Systems Inc.argyle.com