---
title: "Webhook receiver for fdx notifications"
method: POST
path: "/fdx/notifications"
tags: ["plaid"]
---

# Webhook receiver for fdx notifications

`POST /fdx/notifications`

A generic webhook receiver endpoint for FDX Event Notifications

## Request body

- FDXNotification — Provides the base fields of a notification. Clients will read the `type` property to determine the expected notification payload.
  - `notificationId` string, required — Id of notification
  - `type` 'ACCOUNT_TAKEOVER' | 'ADDRESS_CHANGED' | 'BALANCE' | 'CONSENT_EXPIRED' | 'CONSENT_GRANTED' | 'CONSENT_REVOKED' | 'CONSENT_UPDATED' | 'CUSTOM' | 'MFA_TARGET_CHANGED' | 'PHONE_CHANGED' | 'PLANNED_OUTAGE' | 'RISK' | 'SERVICE' | 'SUSPECTED_INCIDENT' | 'TAN_ACTIVATED' | 'TAN_CREATED' | 'TAN_REVOKED' | 'TAN_SUSPENDED', required — Type of Notification
  - `subtype` string — An optional initiator-defined event subtype code or description if the event type needs to be further categorized or described.
  - `sentOn` string, date-time, required — ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to [IETF RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)
  - `category` 'SECURITY' | 'MAINTENANCE' | 'FRAUD' | 'CONSENT' | 'NEW_DATA' | 'TOKENIZED_ACCOUNT_NUMBER', required — Category of Notification
  - `severity` 'EMERGENCY' | 'ALERT' | 'WARNING' | 'NOTICE' | 'INFO' — Severity level of notification
  - `priority` 'HIGH' | 'MEDIUM' | 'LOW' — Priority of notification
  - `publisher` FDXParty — FDX Participant - an entity or person that is a part of a FDX API transaction
    - `name` string, required — Human recognizable common name
    - `type` 'DATA_ACCESS_PLATFORM' | 'DATA_PROVIDER' | 'DATA_RECIPIENT' | 'INDIVIDUAL' | 'MERCHANT' | 'VENDOR', required — Identifies the type of a party
    - `homeUri` string, uri — URI for party, where an end user could learn more about the company or application involved in the data sharing chain
    - `logoUri` string, uri — URI for a logo asset to be displayed to the end user
    - `registry` 'FDX' | 'GLEIF' | 'ICANN' | 'PRIVATE' — The registry containing the party's registration with name and id
    - `registeredEntityName` string — Registered name of party
    - `registeredEntityId` string — Registered id of party
  - `subscriber` FDXParty — FDX Participant - an entity or person that is a part of a FDX API transaction
    - `name` string, required — Human recognizable common name
    - `type` 'DATA_ACCESS_PLATFORM' | 'DATA_PROVIDER' | 'DATA_RECIPIENT' | 'INDIVIDUAL' | 'MERCHANT' | 'VENDOR', required — Identifies the type of a party
    - `homeUri` string, uri — URI for party, where an end user could learn more about the company or application involved in the data sharing chain
    - `logoUri` string, uri — URI for a logo asset to be displayed to the end user
    - `registry` 'FDX' | 'GLEIF' | 'ICANN' | 'PRIVATE' — The registry containing the party's registration with name and id
    - `registeredEntityName` string — Registered name of party
    - `registeredEntityId` string — Registered id of party
  - `notificationPayload` FDXNotificationPayload, required — Custom key-value pairs payload for a notification
    - `id` string — ID for the origination entity related to the notification
    - `idType` 'ACCOUNT' | 'CUSTOMER' | 'PARTY' | 'MAINTENANCE' | 'CONSENT' — Type of entity causing origination of a notification
    - `event` FDXLifecycleEvent — Details of consent or payment network identifier or other entity's revocation request or other lifecycle status change event
      - `status` 'ACTIVE' | 'EXPIRED' | 'REVOKED' | 'SUSPENDED' — Current status of indicated entity after reported event change. Not all statuses will be supported on all entity types by all data providers
      - `reason` 'BUSINESS_RULE' | 'SECURITY_EVENT' | 'USER_ACTION' | 'OTHER' — Reason for lifecycle event status change
      - `otherReason` string — Additional information or description of an `OTHER` reason
      - `initiator` 'DATA_ACCESS_PLATFORM' | 'DATA_PROVIDER' | 'DATA_RECIPIENT' | 'INDIVIDUAL' | 'MERCHANT' | 'VENDOR' — Identifies the type of a party
      - `updatedTime` string, date-time — ISO 8601 date-time in format 'YYYY-MM-DDThh:mm:ss.nnn[Z|[+|-]hh:mm]' according to [IETF RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)
  - `url` FDXHateoasLink — REST application constraint (Hypermedia As The Engine Of Application State)
    - `href` string, uri-reference, required — URL to invoke the action on the resource
    - `action` 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT' — HTTP Method to use for the request
    - `rel` string — Relation of this link to its containing entity, as defined by and with many example relation values at [IETF RFC5988](https://datatracker.ietf.org/doc/html/rfc5988)
    - `types` FDXContentTypes[] — Content-types that can be used in the Accept header

## Response `200`

OK

## Other responses

- `default` — Error response.

---

[API](https://skmtc.net/plaid/apis/the-plaid-api.md) · [All operations](https://skmtc.net/plaid/apis/the-plaid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/plaid/the-plaid-api/versions/64c4514ea59b/schema)