Update a processor token's webhook URL

POST /processor/token/webhook/update

This endpoint allows you, the processor, to update the webhook URL associated with a processor token. This request triggers a WEBHOOK_UPDATE_ACKNOWLEDGED webhook to the newly specified webhook URL.

Request Body

Required

ProcessorTokenWebhookUpdateRequest defines the request schema for /processor/token/webhook/update

Parameters

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.
processor_token
required, string
The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>
webhook
required, string
The new webhook URL to associate with the processor token. To remove a webhook from a processor token, set to null.

Response

ProcessorTokenWebhookUpdateResponse defines the response schema for /processor/token/webhook/update

Response Properties

request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.