Subscribe to an Issue

POST /issues/subscribe

Allows a user to subscribe to updates on a specific Issue using a POST method. Subscribers will receive webhook notifications when the issue status changes, particularly when resolved.

Request Body

Required

IssuesSubscribeRequest defines the request schema for /issues/subscribe.

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.
issue_id
required, string
The unique identifier of the issue to subscribe to.
webhook
required, string
The webhook URL where notifications should be sent when the issue status changes.

Response

IssuesSubscribeResponse defines the response schema for /issues/subscribe.

Response Properties

request_id
required, string
A unique identifier for the API request.