Example subscription
Users
Users.fully_synced webhook
The users.fully_synced webhook is sent after initial data retrieval completes for every payroll account newly connected by a user.
Multiple accounts
- At least one account connection must succeed for this webhook to be sent.
- If a user connects another account after the webhook has already been sent, it is sent again when data retrieval for the new account completes.
Reconnections
For account reconnections, choose the webhook that matches your integration:
- Verifications API: Subscribe to
verifications.updatedwithconfig.include_resource = true.
Indata.resource.status, a report is ready when:stateisCOMPLETEDcodeiscompletedorcompleted_with_errors
- Reports API: Subscribe to
reports.readyto know when sufficient data is available after reconnection and a report can be requested. After requesting it, subscribe toreports.generatedto know when it can be retrieved.
POST
Example subscription
Authorizations
Username = api_key_id, Password = api_key_secret
Body
application/json
users.fully_synced
Your name for the webhook subscription.
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.
Optional secret used to verify webhooks.