Skip to main content
POST
Example subscription

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

The users.fully_synced webhook is not sent when a user reconnects an existing account.
For account reconnections, choose the webhook that matches your integration:
  • Verifications API: Subscribe to verifications.updated with config.include_resource = true.
    In data.resource.status, a report is ready when:
    • state is COMPLETED
    • code is completed or completed_with_errors
  • Reports API: Subscribe to reports.ready to know when sufficient data is available after reconnection and a report can be requested. After requesting it, subscribe to reports.generated to know when it can be retrieved.

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
events
string[]
required

users.fully_synced

name
string
required

Your name for the webhook subscription.

url
string
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. Argyle handles URL encoding for webhook URLs. Send the URL in its normal, unencoded form.

secret
string | null

Optional secret used to verify webhooks.

Response

200 - application/json
event
string

users.fully_synced

name
string

Name used for the webhook subscription.

data
object