Skip to main content
POST
/
v2
/
webhooks
Example subscription
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "users.fully_synced"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret"
}
'
{
  "event": "users.fully_synced",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "resource": {
      "id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
      "accounts_connected": [
        "0185a8b8-60eb-80ca-7482-5f24504573f7",
        "0187c66e-e7e5-811c-b006-2232f00f426a"
      ],
      "items_connected": [
        "item_000000001",
        "item_000000002"
      ],
      "employers_connected": [
        "Whole Goods",
        "Bullseye"
      ],
      "external_metadata": {},
      "external_id": "July_Connection",
      "created_at": "2023-04-27T07:02:01.279Z"
    }
  }
}
Sent when data retrieval has completed for a user.

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