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": [
    "reports.ready"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret"
}
'
{
  "event": "reports.ready",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "resource": {
      "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
      "external_id": "",
      "accounts": [
        {
          "id": "0185a8b8-60eb-80ca-7482-5f24504573f7",
          "last_synced_at": "2024-01-08T12:55:04.016059Z"
        },
        {
          "id": "0187c66e-e7e5-811c-b006-2232f00f426a",
          "last_synced_at": "2024-01-08T12:58:06.023659Z"
        }
      ],
      "documents": []
    }
  }
}
Sent when reports can be or have been generated.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

reports.ready

Example:
["reports.ready"]
​
name
string
required

Your name for the webhook subscription.

Example:

"My Webhook"

​
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.

Example:

"https://your-webhook-backend.com"

​
secret
string

Optional secret used to verify webhooks.

Example:

"your-secret-key"

Response

200 - application/json

Success

​
event
string

reports.ready

Example:

"reports.ready"

​
name
string

Name used for the webhook subscription.

Example:

"My Webhook"

​
data
object