Adyen · Schema

NotificationConfigurationDetails

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
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	array	Contains objects that define event types and their subscription settings.
hmacSignatureKey	string	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 `HmacSignature` and the hash protocol will be inc
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`](htt
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.
sslProtocol	string	The SSL protocol employed by the endpoint. >Permitted values: `TLSv12`, `TLSv13`.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/NotificationConfigurationDetails",
  "title": "NotificationConfigurationDetails",
  "properties": {
    "active": {
      "description": "Indicates whether the notification subscription is active.",
      "type": "boolean"
    },
    "apiVersion": {
      "description": "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.",
      "format": "int32",
      "type": "integer"
    },
    "description": {
      "description": "A description of the notification subscription configuration.",
      "type": "string"
    },
    "eventConfigs": {
      "description": "Contains objects that define event types and their subscription settings.",
      "items": {
        "$ref": "#/components/schemas/NotificationEventConfiguration"
      },
      "type": "array"
    },
    "hmacSignatureKey": {
      "x-addedInVersion": "5",
      "description": "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 `HmacSignature` and the hash protocol will be included under the notification header `Protocol`. A notification body along with its `hmacSignatureKey` and `Protocol` can be used to calculate a hash value; matching this hash value with the `HmacSignature` will ensure that the notification body has not been tampered with or corrupted.\n\n>Must be a 32-byte hex-encoded string (i.e. a string containing 64 hexadecimal characters; e.g. \"b0ea55c2fe60d4d1d605e9c385e0e7f7e6cafbb939ce07010f31a327a0871f27\").\n\nThe omission of this field will preclude the provision of the `HmacSignature` and `Protocol` headers in notification(s).",
      "type": "string"
    },
    "notificationId": {
      "description": "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).",
      "format": "int64",
      "type": "integer"
    },
    "notifyPassword": {
      "description": "The password to use when accessing the notifyURL with the specified username.",
      "type": "string"
    },
    "notifyURL": {
      "description": "The URL to which the notifications are to be sent.",
      "type": "string"
    },
    "notifyUsername": {
      "description": "The username to use when accessing the notifyURL.",
      "type": "string"
    },
    "sslProtocol": {
      "description": "The SSL protocol employed by the endpoint.\n>Permitted values: `TLSv12`, `TLSv13`.",
      "enum": [
        "TLSv12",
        "TLSv13"
      ],
      "type": "string"
    }
  },
  "type": "object"
}