Deposit Destinations Webhooks
Sent when an account's deposit destinations change.
#Added
The deposit_destinations.added webhook is sent when a new deposit destination has been added to a connected account.
This webhook is sent each time a deposit destination is found during initial data retrieval, but can also be triggered if the user independently adds a new deposit destinations or a deposit switch you initiate that adds a new deposit destination is successful.
- #eventsarray of stringsrequired
deposit_destinations.added - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
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.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["deposit_destinations.added"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "deposit_destinations.added",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "deposit_destination": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55"
8 }
9}#Updated
The deposit_destinations.updated webhook is sent when a change is detected in an existing deposit destination's settings.
This includes when a user independently updates their settings, or if a deposit switch you initiate updates the user's deposit settings.
- #eventsarray of stringsrequired
deposit_destinations.updated - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
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.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["deposit_destinations.updated"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "deposit_destinations.updated",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "deposit_destination": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55"
8 }
9}#Removed
The deposit_destinations.removed webhook is sent when a deposit destination object has been deleted after one of the user's previous deposit destinations was not found when the account's data was refreshed.
- #eventsarray of stringsrequired
deposit_destinations.removed - #namestringrequired
Your name for the webhook subscription.
- #urlstringrequired
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.
- #secretstringoptional
Optional secret used to verify webhooks.
1curl --request POST \
2 --url https://api.argyle.com/v2/webhooks \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json' \
5 --data '{
6 "events": ["deposit_destinations.removed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret"
10 }'1{
2 "event": "deposit_destinations.removed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
7 "deposit_destination": "0176e1ea-60ca-c561-eb8e-6dcdb33b1b55"
8 }
9}