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.
Servers
- https://cal-test.adyen.com/cal/services/Notification/v6
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 |
|---|---|---|---|
configurationDetails |
Object | Yes |
Details of the prospective notification subscription configuration. |
configurationDetails.notifyPassword |
String | No |
The password to use when accessing the notifyURL with the specified username. |
configurationDetails.active |
Boolean | No |
Indicates whether the notification subscription is active. |
configurationDetails.description |
String | No |
A description of the notification subscription configuration. |
configurationDetails.notifyURL |
String | No |
The URL to which the notifications are to be sent. |
configurationDetails.sslProtocol |
String | No |
The SSL protocol employed by the endpoint.
Possible values:
|
configurationDetails.notificationId |
Integer | No |
Adyen-generated ID for the entry, returned in the response when you create a notification configuration. Required when updating an existing configuration using |
configurationDetails.notifyUsername |
String | No |
The username to use when accessing the notifyURL. |
configurationDetails.hmacSignatureKey |
String | No |
A string with which to salt the notification(s) before hashing. If this field is provided, a hash value will be included under the notification header
The omission of this field will preclude the provision of the |
configurationDetails.apiVersion |
Integer | No |
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. |
configurationDetails.eventConfigs[] |
Array | No |
Contains objects that define event types and their subscription settings. |
configurationDetails.eventConfigs[].includeMode |
String | Yes |
Indicates whether the specified
Possible values:
|
configurationDetails.eventConfigs[].eventType |
String | Yes |
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. 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.