Reports.ready webhook

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"
}
'

import requests

url = "https://api-sandbox.argyle.com/v2/webhooks"

payload = {
    "events": ["reports.ready"],
    "name": "name-for-the-webhook-subscription",
    "url": "https://your-webhook-backend.com",
    "secret": "optional-secret"
}
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: ['reports.ready'],
    name: 'name-for-the-webhook-subscription',
    url: 'https://your-webhook-backend.com',
    secret: 'optional-secret'
  })
};

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' => [
        'reports.ready'
    ],
    'name' => 'name-for-the-webhook-subscription',
    'url' => 'https://your-webhook-backend.com',
    'secret' => 'optional-secret'
  ]),
  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    \"reports.ready\"\n  ],\n  \"name\": \"name-for-the-webhook-subscription\",\n  \"url\": \"https://your-webhook-backend.com\",\n  \"secret\": \"optional-secret\"\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    \"reports.ready\"\n  ],\n  \"name\": \"name-for-the-webhook-subscription\",\n  \"url\": \"https://your-webhook-backend.com\",\n  \"secret\": \"optional-secret\"\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    \"reports.ready\"\n  ],\n  \"name\": \"name-for-the-webhook-subscription\",\n  \"url\": \"https://your-webhook-backend.com\",\n  \"secret\": \"optional-secret\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": []
    }
  }
}

POST

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"
}
'

import requests

url = "https://api-sandbox.argyle.com/v2/webhooks"

payload = {
    "events": ["reports.ready"],
    "name": "name-for-the-webhook-subscription",
    "url": "https://your-webhook-backend.com",
    "secret": "optional-secret"
}
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: ['reports.ready'],
    name: 'name-for-the-webhook-subscription',
    url: 'https://your-webhook-backend.com',
    secret: 'optional-secret'
  })
};

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' => [
        'reports.ready'
    ],
    'name' => 'name-for-the-webhook-subscription',
    'url' => 'https://your-webhook-backend.com',
    'secret' => 'optional-secret'
  ]),
  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    \"reports.ready\"\n  ],\n  \"name\": \"name-for-the-webhook-subscription\",\n  \"url\": \"https://your-webhook-backend.com\",\n  \"secret\": \"optional-secret\"\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    \"reports.ready\"\n  ],\n  \"name\": \"name-for-the-webhook-subscription\",\n  \"url\": \"https://your-webhook-backend.com\",\n  \"secret\": \"optional-secret\"\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    \"reports.ready\"\n  ],\n  \"name\": \"name-for-the-webhook-subscription\",\n  \"url\": \"https://your-webhook-backend.com\",\n  \"secret\": \"optional-secret\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": []
    }
  }
}

The webhook is sent once sufficient data has been retrieved from a connected payroll account. It is also sent after an account reconnection once all new data has been retrieved.

This webhook may be sent multiple times if the user connects multiple accounts.

The accounts.connected and accounts.failed webhooks can be used to track multiple account connections.
Compare them to the accounts listed in the reports.ready webhook payload to determine when to generate a report.

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

Show child attributes

Core Resources

Coverage

Payroll Data Sets

Banking

Reports

Workflows

Verifications

Partners Verifications

Webhooks

Receipts

Error Codes

Reports.ready webhook

Authorizations

Body

Response