Skip to main content
POST
Example subscription
This includes when:
  1. The user submits login credentials that fail to authenticate.
  2. The user submits login credentials to re-authenticate an account and authentication fails.
  3. The user submits login credentials but there is a timeout during a required multi-factor authentication (MFA) process.
To stay notified of account disconnections, instead use the accounts.updated webhook with a resource object included, and check for changes the account object’s connection.status property.

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
events
enum<string>[]
required

Array containing the accounts.failed event. Value: accounts.failed

Available options:
accounts.failed
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

Optional secret used to verify webhooks.

config
object

Response

200 - application/json
event
string

The event that triggered the webhook.

Example:

"accounts.failed"

name
string

Name used for the webhook subscription.

Example:

"name-for-the-webhook-subscription"

data
object