Skip to main content
POST
/
v2
/
webhooks
Added
curl --request POST \
  --url https://api-sandbox.argyle.com/v2/webhooks \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "events": [
    "<string>"
  ],
  "name": "<string>",
  "url": "<string>",
  "secret": "<string>"
}
'
{
  "event": "<string>",
  "name": "<string>",
  "data": {
    "account": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "deposit_destination": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
Sent when an account’s deposit destinations change.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Body

application/json
​
events
string[]

deposit_destinations.added

​
name
string

Your name for the webhook subscription.

​
url
string

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.

​
secret
string

Optional secret used to verify webhooks.

Response

200 - application/json

Success

Added

​
event
string

deposit_destinations.added

​
name
string

Name used for the webhook subscription.

​
data
object