Items Webhooks
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.
#Updated
The items.updated webhook is sent when there is any change to a property value of an Item object.
The config parameter is required when subscribing to the items.updated webhook.
- #eventsarray of stringsrequired
items.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.
- #configobjectrequired
Object containing an array of up to
30Item ID's.
- #eventstring
items.updated - #namestring
Name used for the webhook subscription.
- #dataobject
- #itemstring
ID of the Item.
- #namestring
Name of the Item.
- #statusstring
The
statusof the Item. - #status_detailsstring
The
status_detailsof the Item. - #mapping_statusstring
The
mapping_statusof the Item. - #known_limitationsstring
The
known_limitationsof the Item. - #logo_urlstring
URL location of the Item's logo image file.
- #featuresobject
What data fields the Item supports, and the Item's deposit switch capabilities.
- #field_coverageobject
Contains information on whether the Item returns data for a particular property within one of Argyle's data sets.
Does not include object ID's, account ID's, or metadata.nullvalues are returned for properties of new or uncommon Items until a determination on data availability can be made. - #identitiesobject
All data fields of the identity object.
- #paystubsobject
All data fields of the paystub object.
- #payroll_documentsobject
All data fields of the payroll document object.
- #deposit_destinationsobject
All data fields of the deposit destination object.
- #shiftsobject
All data fields of the shift object.
- #gigsobject
All data fields of the gig object.
- #shiftsobject
(Upcoming release) All data fields of the shift object.
- #vehiclesobject
All data fields of the vehicle object.
- #ratingsobject
All data fields of the rating object.
- #direct_deposit_switchobject
Contains information on the Item's deposit switch capabilities.
- #cardobject
Card update capabilities.
- #deposit_accountobject
Direct deposit capabilities.
- #typesarray of strings
The types of bank accounts supported.
- #supportedboolean
trueif the Item supports deposit switching. - #max_allocationsstring (integer)
Number of total bank accounts supported by the Item's underlying platform.
- #amount_allocationboolean
trueif the Item's direct deposit settings support using exact amounts to define how pay is allocated to different bank accounts. - #percent_allocationboolean
trueif the Item's direct deposit settings support using exact percentages of total pay to define how pay is allocated to different bank accounts. - #amount_precisionstring (enum)
What level of precision is allowed when setting amount allocations.
- #percent_precisionstring (enum)
What level of precision is allowed when setting percentage allocations.
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": ["items.updated"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret",
10 "config": {
11 "items": ["item_123456789", "item_000000001"]
12 }
13 }'1{
2 "event": "items.updated",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "item": "item_000000001",
6 "name": "Whole Goods",
7 "status": "issues",
8 "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.",
9 "mapping_status": "verified",
10 "known_limitations": "First 5 digits of SSN obfuscated.",
11 "logo_url": "argyle.com/image-holdings",
12 "features": {
13 "field_coverage": {
14 "identities": {
15 "first_name": {
16 "supported": true
17 },
18 "last_name": {
19 "supported": true
20 },
21 "...": {
22 "supported": true
23 }
24 },
25 "paystubs": {
26 "...": {
27 "supported": true
28 }
29 },
30 "payroll_documents": {
31 "...": {
32 "supported": true
33 }
34 },
35 "deposit_destinations": {
36 "...": {
37 "supported": true
38 }
39 },
40 "shifts": {
41 "...": {
42 "supported": true
43 }
44 },
45 "gigs": {
46 "...": {
47 "supported": true
48 }
49 },
50 "vehicles": {
51 "...": {
52 "supported": true
53 }
54 },
55 "ratings": {
56 "...": {
57 "supported": true
58 }
59 }
60 },
61 "direct_deposit_switch": {
62 "card": {
63 "supported": true,
64 "max_allocations": "3"
65 },
66 "deposit_account": {
67 "types": [
68 "ach_deposit_account"
69 ],
70 "supported": true,
71 "max_allocations": "2",
72 "amount_allocation": false,
73 "percent_allocation": true,
74 "amount_precision": null,
75 "percent_precision": "0.01"
76 }
77 }
78 }
79 }
80}#Removed
The items.removed webhook is sent when an existing Item is deleted and removed from Link.
The config parameter is required when subscribing to the items.removed webhook.
- #eventsarray of stringsrequired
items.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.
- #configobjectrequired
Object containing an array of up to
30Item ID's.
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": ["items.removed"],
7 "name": "name-for-the-webhook-subscription",
8 "url": "https://your-webhook-backend.com",
9 "secret": "optional-secret",
10 "config": {
11 "items": ["item_123456789", "item_000000001"]
12 }
13 }'1{
2 "event": "items.removed",
3 "name": "name-for-the-webhook-subscription",
4 "data": {
5 "item": "item_000000001"
6 }
7}