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": [
    "verifications.creation_failed"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://webhooks.example.com/argyle/verifications-creation-failed",
  "secret": "secret-value"
}
'
{
  "event": "verifications.creation_failed",
  "name": "name-for-the-webhook-subscription",
  "data": {
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "context": {
      "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
      "attempted_at": "2023-03-09T16:22:06.081Z",
      "channel": "encompass",
      "data_source": "banking",
      "report_type": "voa",
      "loan": {
        "number": "1234",
        "borrower_id": "ABC789",
        "application_id": "2121313",
        "officer_email": "john.doe@mortgage.com"
      },
      "billing": {
        "cost_center": "5"
      }
    }
  }
}
Sent when creating a verification fails.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
enum<string>[]
required

verifications.creation_failed

Available options:
verifications.creation_failed
​
name
string
required

Your name for the webhook subscription.

Example:

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

Example:

"https://webhooks.example.com/argyle/verifications-creation-failed"

​
secret
string

Optional secret used to verify webhooks.

Example:

"secret-value"

Response

200 - application/json
​
event
string

verifications.creation_failed

Example:

"verifications.creation_failed"

​
name
string

Name used for the webhook subscription.

Example:

"name-for-the-webhook-subscription"

​
data
object