Fully synced

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.

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 our webhooks reference for a complete list.

Event

users.fully_synced

Payload

ATTRIBUTETYPEDESCRIPTION
userstring uuidID of the user
resourceobjectContains the ID of the user and lists of payroll providers and employers connected.

Examples

curl -X POST https://api.argyle.com/v1/webhooks \
  -u api_key_id:api_key_secret \
  -H "Content-Type: application/json" \
  -d '{"events": ["users.fully_synced"],
       "secret": "<secret for signature verification>",
         "name": "<name for your webhook>",
          "url": "https://webhook.site/url"}'
{
    "name": "<name for your webhook>",
    "event": "users.fully_synced",
    "data": {
        "user": "01838ad1-b6bd-22f8-22f1-d3f5b3953484",
        "resource": {
            "id": "01838ad1-b6bd-22f8-22f1-d3f5b3953484",
            "data_providers_connected": [
                "mypayroll_platform"
            ],
            "employers_connected": [
                "Whole Goods",
                "SprintCar"
            ],
            "external_metadata": {
                "key": "value"
            },
            "created_at": "2022-09-29T19:55:43.166095Z"
        }
    }
}