Item

itemWebhookUpdate

POST
/item/webhook/update

The POST /item/webhook/update allows you to update the webhook URL associated with an Item. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED webhook to the newly specified webhook URL.

Authorization

PLAID-CLIENT-ID PLAID-SECRET Plaid-Version
PLAID-CLIENT-ID<token>

In: header

PLAID-SECRET<token>

In: header

Plaid-Version<token>

In: header

Request Body

application/json

ItemWebhookUpdateRequest defines the request schema for /item/webhook/update

client_id?string

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secret?string

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

access_token*string

The access token associated with the Item data is being requested for.

webhook*string

The new webhook URL to associate with the Item.

Response Body

application/json

curl -X POST "https://example.com/item/webhook/update" \  -H "Content-Type: application/json" \  -d '{    "access_token": "string",    "webhook": "string"  }'
{  "item": {    "available_products": [      "balance",      "identity",      "payment_initiation",      "transactions"    ],    "billed_products": [      "assets",      "auth"    ],    "consent_expiration_time": null,    "error": null,    "institution_id": "ins_117650",    "item_id": "DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6",    "update_type": "background",    "webhook": "https://www.genericwebhookurl.com/webhook"  },  "request_id": "vYK11LNTfRoAMbj"}