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.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
issue_id |
String | Yes |
The unique identifier of the issue to subscribe to. |
client_id |
String | No |
Your Plaid API |
webhook |
String | Yes |
The webhook URL where notifications should be sent when the issue status changes. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.