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"
}
'import requests
url = "https://api-sandbox.argyle.com/v2/webhooks"
payload = {
"events": ["verifications.creation_failed"],
"name": "name-for-the-webhook-subscription",
"url": "https://webhooks.example.com/argyle/verifications-creation-failed",
"secret": "secret-value"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: ['verifications.creation_failed'],
name: 'name-for-the-webhook-subscription',
url: 'https://webhooks.example.com/argyle/verifications-creation-failed',
secret: 'secret-value'
})
};
fetch('https://api-sandbox.argyle.com/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
'verifications.creation_failed'
],
'name' => 'name-for-the-webhook-subscription',
'url' => 'https://webhooks.example.com/argyle/verifications-creation-failed',
'secret' => 'secret-value'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/webhooks"
payload := strings.NewReader("{\n \"events\": [\n \"verifications.creation_failed\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-creation-failed\",\n \"secret\": \"secret-value\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.argyle.com/v2/webhooks")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n \"verifications.creation_failed\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-creation-failed\",\n \"secret\": \"secret-value\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n \"verifications.creation_failed\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-creation-failed\",\n \"secret\": \"secret-value\"\n}"
response = http.request(request)
puts response.read_body{
"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"
}
}
}
}Verifications
Verifications.creation_failed webhook
The verifications.creation_failed webhook is sent when Argyle fails to create a verification.
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"
}
'import requests
url = "https://api-sandbox.argyle.com/v2/webhooks"
payload = {
"events": ["verifications.creation_failed"],
"name": "name-for-the-webhook-subscription",
"url": "https://webhooks.example.com/argyle/verifications-creation-failed",
"secret": "secret-value"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
events: ['verifications.creation_failed'],
name: 'name-for-the-webhook-subscription',
url: 'https://webhooks.example.com/argyle/verifications-creation-failed',
secret: 'secret-value'
})
};
fetch('https://api-sandbox.argyle.com/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.argyle.com/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'events' => [
'verifications.creation_failed'
],
'name' => 'name-for-the-webhook-subscription',
'url' => 'https://webhooks.example.com/argyle/verifications-creation-failed',
'secret' => 'secret-value'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-sandbox.argyle.com/v2/webhooks"
payload := strings.NewReader("{\n \"events\": [\n \"verifications.creation_failed\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-creation-failed\",\n \"secret\": \"secret-value\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-sandbox.argyle.com/v2/webhooks")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"events\": [\n \"verifications.creation_failed\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-creation-failed\",\n \"secret\": \"secret-value\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"events\": [\n \"verifications.creation_failed\"\n ],\n \"name\": \"name-for-the-webhook-subscription\",\n \"url\": \"https://webhooks.example.com/argyle/verifications-creation-failed\",\n \"secret\": \"secret-value\"\n}"
response = http.request(request)
puts response.read_body{
"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
Username = api_key_id, Password = api_key_secret
Body
application/json
verifications.creation_failed
Available options:
verifications.creation_failed Your name for the webhook subscription.
Example:
"name-for-the-webhook-subscription"
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"
Optional secret used to verify webhooks.
Example:
"secret-value"
⌘I