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.removed"
  ],
  "name": "name-for-the-webhook-subscription",
  "url": "https://your-webhook-backend.com",
  "secret": "optional-secret",
  "config": {
    "items": [
      "item_123456789",
      "item_000000001"
    ]
  }
}
'
{
  "event": "items.removed",
  "name": "My Items Removed Webhook",
  "data": {
    "item": "item_000000001"
  }
}

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]
required

items.removed

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

Your name for the webhook subscription.

Example:

"My Items Removed 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.removed

Example:

"items.removed"

​
name
string

Name used for the webhook subscription.

Example:

"My Items Removed Webhook"

​
data
object