---
title: "Subscribe to notifications"
method: POST
path: "/createNotificationConfiguration"
tags: ["General"]
---

# Subscribe to notifications

`POST /createNotificationConfiguration`

Creates a subscription to notifications informing you of events on your platform. After the subscription is created, the events specified in the configuration will be sent to the URL specified in the configuration. Subscriptions must be configured on a per-event basis (as opposed to, for example, a per-account holder basis), so all event notifications of a marketplace and of a given type will be sent to the same endpoint(s). A marketplace may have multiple endpoints if desired; an event notification may be sent to as many or as few different endpoints as configured.

## Request body

- CreateNotificationConfigurationRequest
  - `configurationDetails` NotificationConfigurationDetails, required
    - `active` boolean — Indicates whether the notification subscription is active.
    - `apiVersion` integer — The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.
    - `description` string — A description of the notification subscription configuration.
    - `eventConfigs` NotificationEventConfigurationWrapper[] — Contains objects that define event types and their subscription settings.
      - `NotificationEventConfiguration` NotificationEventConfiguration
        - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_FUNDS_BELOW_THRESHOLD' | 'ACCOUNT_HOLDER_CREATED' | 'ACCOUNT_HOLDER_LIMIT_REACHED' | 'ACCOUNT_HOLDER_MIGRATED' | 'ACCOUNT_HOLDER_PAYOUT' | 'ACCOUNT_HOLDER_STATUS_CHANGE' | 'ACCOUNT_HOLDER_STORE_STATUS_CHANGE' | 'ACCOUNT_HOLDER_UPCOMING_DEADLINE' | 'ACCOUNT_HOLDER_UPDATED' | 'ACCOUNT_HOLDER_VERIFICATION' | 'ACCOUNT_UPDATED' | 'BENEFICIARY_SETUP' | 'COMPENSATE_NEGATIVE_BALANCE' | 'DIRECT_DEBIT_INITIATED' | 'FUNDS_MIGRATED' | 'PAYMENT_FAILURE' | 'PENDING_CREDIT' | 'REFUND_FUNDS_TRANSFER' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'SCORE_SIGNAL_TRIGGERED' | 'TRANSFER_FUNDS' | 'TRANSFER_NOT_PAIDOUT_TRANSFERS', required — The type of event. Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.
        - `includeMode` 'EXCLUDE' | 'INCLUDE', required — Indicates whether the specified `eventType` is sent to your webhook endpoint. Possible values: * **INCLUDE**: Send the specified `eventType`. * **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.
    - `messageFormat` 'JSON' | 'SOAP' — The data format of the notification to be sent. >Permitted values: `JSON`, `SOAP`.
    - `notificationId` integer — Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).
    - `notifyPassword` string — The password to use when accessing the notifyURL with the specified username.
    - `notifyURL` string — The URL to which the notifications are to be sent.
    - `notifyUsername` string — The username to use when accessing the notifyURL.
    - `sendActionHeader` boolean — Indicates whether an action header should be included. >Only applies to SOAP messages (as specified in messageFormat).
    - `sslProtocol` 'TLSv12' | 'TLSv13' — The SSL protocol employed by the endpoint. >Permitted values: `TLSv12`, `TLSv13`.

## Response `200`

OK - the request has succeeded.

- GetNotificationConfigurationResponse
  - `configurationDetails` NotificationConfigurationDetails, required
    - `active` boolean — Indicates whether the notification subscription is active.
    - `apiVersion` integer — The version of the notification to which you are subscribing. To make sure that your integration can properly process the notification, subscribe to the same version as the API that you're using.
    - `description` string — A description of the notification subscription configuration.
    - `eventConfigs` NotificationEventConfigurationWrapper[] — Contains objects that define event types and their subscription settings.
      - `NotificationEventConfiguration` NotificationEventConfiguration
        - `eventType` 'ACCOUNT_CLOSED' | 'ACCOUNT_CREATED' | 'ACCOUNT_FUNDS_BELOW_THRESHOLD' | 'ACCOUNT_HOLDER_CREATED' | 'ACCOUNT_HOLDER_LIMIT_REACHED' | 'ACCOUNT_HOLDER_MIGRATED' | 'ACCOUNT_HOLDER_PAYOUT' | 'ACCOUNT_HOLDER_STATUS_CHANGE' | 'ACCOUNT_HOLDER_STORE_STATUS_CHANGE' | 'ACCOUNT_HOLDER_UPCOMING_DEADLINE' | 'ACCOUNT_HOLDER_UPDATED' | 'ACCOUNT_HOLDER_VERIFICATION' | 'ACCOUNT_UPDATED' | 'BENEFICIARY_SETUP' | 'COMPENSATE_NEGATIVE_BALANCE' | 'DIRECT_DEBIT_INITIATED' | 'FUNDS_MIGRATED' | 'PAYMENT_FAILURE' | 'PENDING_CREDIT' | 'REFUND_FUNDS_TRANSFER' | 'REPORT_AVAILABLE' | 'SCHEDULED_REFUNDS' | 'SCORE_SIGNAL_TRIGGERED' | 'TRANSFER_FUNDS' | 'TRANSFER_NOT_PAIDOUT_TRANSFERS', required — The type of event. Possible values: **ACCOUNT_CLOSED**, **ACCOUNT_CREATED**, **ACCOUNT_FUNDS_BELOW_THRESHOLD**, **ACCOUNT_HOLDER_CREATED**, **ACCOUNT_HOLDER_LIMIT_REACHED**, **ACCOUNT_HOLDER_PAYOUT**, **ACCOUNT_HOLDER_STATUS_CHANGE**, **ACCOUNT_HOLDER_STORE_STATUS_CHANGE**, **ACCOUNT_HOLDER_UPCOMING_DEADLINE**, **ACCOUNT_HOLDER_UPDATED**, **ACCOUNT_HOLDER_VERIFICATION**, **ACCOUNT_UPDATED**, **BENEFICIARY_SETUP**, **COMPENSATE_NEGATIVE_BALANCE**, **DIRECT_DEBIT_INITIATED**, **PAYMENT_FAILURE**, **REFUND_FUNDS_TRANSFER**, **REPORT_AVAILABLE**, **SCHEDULED_REFUNDS**, **TRANSFER_FUNDS**.
        - `includeMode` 'EXCLUDE' | 'INCLUDE', required — Indicates whether the specified `eventType` is sent to your webhook endpoint. Possible values: * **INCLUDE**: Send the specified `eventType`. * **EXCLUDE**: Send all event types except the specified `eventType` and other event types with the `includeMode` set to **EXCLUDE**.
    - `messageFormat` 'JSON' | 'SOAP' — The data format of the notification to be sent. >Permitted values: `JSON`, `SOAP`.
    - `notificationId` integer — Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using [`/updateNotificationConfiguration`](https://docs.adyen.com/api-explorer/#/NotificationConfigurationService/latest/post/updateNotificationConfiguration).
    - `notifyPassword` string — The password to use when accessing the notifyURL with the specified username.
    - `notifyURL` string — The URL to which the notifications are to be sent.
    - `notifyUsername` string — The username to use when accessing the notifyURL.
    - `sendActionHeader` boolean — Indicates whether an action header should be included. >Only applies to SOAP messages (as specified in messageFormat).
    - `sslProtocol` 'TLSv12' | 'TLSv13' — The SSL protocol employed by the endpoint. >Permitted values: `TLSv12`, `TLSv13`.
  - `pspReference` string — The reference of a request. Can be used to uniquely identify the request.
  - `resultCode` string — The result code.
  - `submittedAsync` boolean — Indicates whether the request is processed asynchronously. Depending on the request's platform settings, the following scenarios may be applied: * **true**: The request is queued and will be executed when the providing service is available in the order in which the requests are received. * **false**: The processing of the request is immediately attempted; it may result in an error if the providing service is unavailable.

## Other responses

- `400` — Bad Request - a problem reading or understanding the request.
- `401` — Unauthorized - authentication required.
- `403` — Forbidden - insufficient permissions to process the request.
- `422` — Unprocessable Entity - a request validation error.
- `500` — Internal Server Error - the server could not process the request.

## Changes

- **2023-04-12** (v1) `45a1cea670d3` — 4 breaking, 2 warning, 2 info
  - the `configurationDetails/eventConfigs/items/` request property type/format changed from `object`/`` to ``/``
  - the `configurationDetails/eventConfigs/items/` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - removed the required property `configurationDetails/eventConfigs/items/eventType` from the response with the `200` status
  - removed the required property `configurationDetails/eventConfigs/items/includeMode` from the response with the `200` status
  - …4 more
- **2023-03-22** (v1) `006529adfbf8` — 13 breaking, 1 warning, 3 info
  - the request's body type/format changed from ``/`` to `object`/``
  - the `configurationDetails` request property type/format changed from ``/`` to `object`/``
  - the `configurationDetails/eventConfigs/items/` request property type/format changed from ``/`` to `object`/``
  - the response's body type/format changed from ``/`` to `object`/`` for status `200`
  - …13 more
- **2022-10-06** (v1) `0def803273ac` — 6 breaking, 2 warning, 8 info
  - removed the enum value `SSL` of the request property `configurationDetails/sslProtocol`
  - removed the enum value `SSLInsecureCiphers` of the request property `configurationDetails/sslProtocol`
  - removed the enum value `TLS` of the request property `configurationDetails/sslProtocol`
  - removed the enum value `TLSv10` of the request property `configurationDetails/sslProtocol`
  - …12 more
- …earlier changes not shown

[Full history](https://skmtc.dev/adyen/apis/notificationconfigurationservice/changes/createNotificationConfiguration/post.md)

---

[API](https://skmtc.dev/adyen/apis/notificationconfigurationservice.md) · [All operations](https://skmtc.dev/adyen/apis/notificationconfigurationservice/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/adyen/notificationconfigurationservice/revisions/7c50dc09939d/schema)