Legacy Docs

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

post/v2/webhooks

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.

Request body
  • eventsarray of strings
    required

    items.updated

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    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.

  • secretstring
    optional

    Optional secret used to verify webhooks.

  • configobject
    required

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

Webhook message
  • eventstring

    items.updated

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • itemstring

    ID of the Item.

  • namestring

    Name of the Item.

  • statusstring

    The status of the Item.

  • status_detailsstring

    The status_details of the Item.

  • mapping_statusstring

    The mapping_status of the Item.

  • known_limitationsstring

    The known_limitations of the Item.

  • logo_urlstring

    URL location of the Item's logo image file.

Example Subscription
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     }'
Example Webhook
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  }
13}

#Removed

post/v2/webhooks

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.

Request body
  • eventsarray of strings
    required

    items.removed

  • namestring
    required

    Your name for the webhook subscription.

  • urlstring
    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.

  • secretstring
    optional

    Optional secret used to verify webhooks.

  • configobject
    required

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

Webhook message
  • eventstring

    items.removed

  • namestring

    Name used for the webhook subscription.

  • dataobject

  • itemstring

    ID of the Item.

Example Subscription
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     }'
Example Webhook
1{
2  "event": "items.removed",
3  "name": "name-for-the-webhook-subscription",
4  "data": {
5    "item": "item_000000001"
6  }
7}