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": [
    "items.updated"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret",
  "config": {
    "items": [
      "item_123456789",
      "item_000000001"
    ]
  }
}
'
{
  "event": "items.updated",
  "name": "My Items Updated Webhook",
  "data": {
    "item": "item_000000001",
    "name": "Whole Goods",
    "status": "issues",
    "status_details": "We have identified issues with the underlying platform. We are actively investigating and will provide an update by May 25, 16:00 UTC at the latest.",
    "mapping_status": "verified",
    "known_limitations": "First 5 digits of SSN obfuscated.",
    "logo_url": "argyle.com/image-holdings",
    "features": {
      "field_coverage": {
        "identities": {
          "first_name": {
            "supported": true
          },
          "last_name": {
            "supported": true
          },
          "...": {
            "supported": true
          }
        },
        "paystubs": {
          "...": {
            "supported": true
          }
        },
        "payroll_documents": {
          "...": {
            "supported": true
          }
        },
        "deposit_destinations": {
          "...": {
            "supported": true
          }
        },
        "shifts": {
          "...": {
            "supported": true
          }
        },
        "gigs": {
          "...": {
            "supported": true
          }
        },
        "vehicles": {
          "...": {
            "supported": true
          }
        },
        "ratings": {
          "...": {
            "supported": true
          }
        }
      },
      "direct_deposit_switch": {
        "card": {
          "supported": true,
          "max_allocations": "3"
        },
        "deposit_account": {
          "types": [
            "ach_deposit_account"
          ],
          "supported": true,
          "max_allocations": "2",
          "amount_allocation": false,
          "percent_allocation": true,
          "amount_precision": null,
          "percent_precision": "0.01"
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.argyle.com/llms.txt

Use this file to discover all available pages before exploring further.

Sent when Items are updated or removed.
Subscribing to all webhooks at once via Console or via the API will not create subscriptions to Items webhooks, which must be subscribed to individually with specific Items listed within the config parameter.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

items.updated

Example:
["items.updated"]
​
name
string
required

Your name for the webhook subscription.

Example:

"My Items Updated 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-endpoint.com"

​
config
object
required

Object containing an array of up to 30 Item ID's.

​
secret
string | null

Optional secret used to verify webhooks.

Example:

"your_secret_key"

Response

200 - application/json
​
event
string

items.updated

Example:

"items.updated"

​
name
string

Name used for the webhook subscription.

Example:

"My Items Updated Webhook"

​
data
object