POST /fdx/notifications
A generic webhook receiver endpoint for FDX Event Notifications
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 |
|---|---|---|---|
category |
String | Yes |
Category of Notification Possible values:
|
priority |
String | No |
Priority of notification Possible values:
|
publisher |
Object | No |
FDX Participant - an entity or person that is a part of a FDX API transaction |
publisher.name |
String | Yes |
Human recognizable common name |
publisher.homeUri |
String | No |
URI for party, where an end user could learn more about the company or application involved in the data sharing chain |
publisher.type |
String | Yes |
Identifies the type of a party Possible values:
|
publisher.registeredEntityId |
String | No |
Registered id of party |
publisher.logoUri |
String | No |
URI for a logo asset to be displayed to the end user |
publisher.registry |
String | No |
The registry containing the party’s registration with name and id Possible values:
|
publisher.registeredEntityName |
String | No |
Registered name of party |
url |
Object | No |
REST application constraint (Hypermedia As The Engine Of Application State) |
url.href |
String | Yes |
URL to invoke the action on the resource |
url.action |
String | No |
HTTP Method to use for the request Possible values:
|
url.types[] |
Array | No |
Content-types that can be used in the Accept header |
url.rel |
String | No |
Relation of this link to its containing entity, as defined by and with many example relation values at IETF RFC5988 |
subscriber |
Object | No |
FDX Participant - an entity or person that is a part of a FDX API transaction |
subscriber.name |
String | Yes |
Human recognizable common name |
subscriber.homeUri |
String | No |
URI for party, where an end user could learn more about the company or application involved in the data sharing chain |
subscriber.type |
String | Yes |
Identifies the type of a party Possible values:
|
subscriber.registeredEntityId |
String | No |
Registered id of party |
subscriber.logoUri |
String | No |
URI for a logo asset to be displayed to the end user |
subscriber.registry |
String | No |
The registry containing the party’s registration with name and id Possible values:
|
subscriber.registeredEntityName |
String | No |
Registered name of party |
notificationId |
String | Yes |
Id of notification |
type |
String | Yes |
Type of Notification Possible values:
|
sentOn |
String | Yes |
ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to IETF RFC3339 |
notificationPayload |
Object | Yes |
Custom key-value pairs payload for a notification |
notificationPayload.id |
String | No |
ID for the origination entity related to the notification |
notificationPayload.customFields[] |
Array | No | |
notificationPayload.customFields[].name |
String | Yes |
Name of attribute |
notificationPayload.customFields[].value |
String | Yes |
Value of attribute |
notificationPayload.idType |
String | No |
Type of entity causing origination of a notification Possible values:
|
severity |
String | No |
Severity level of notification Possible values:
|
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.