Notification Registry 0.1.0

The Notification Registry is used to register and interact with webhook configurations for the Redeam Notification service.

Server

https://notifications.redeam.io/registry/v1

https://notifications.sandbox.redeam.io/registry/v1

https://notifications.develop.redeam.io/registry/v1

Channelbinding

ChannelBinding notification rules

Get a channelbinding notification rule

Get the channelbinding notification rule associated with the account

Auth

GET /channelbindings

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/channelbindings'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of channel binding notifications to subscribe to. Enum: `created`,`updated`,`removed`

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "created",   "updated"  ] }}
Copy

Update a channelbinding notification rule

Update an existing channelbinding notification rule for the user's channel-id.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of channel binding notifications to subscribe to. Enum: `created`,`updated`,`removed`

PUT /channelbindings

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/channelbindings' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "created",      "updated"    ]  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of channel binding notifications to subscribe to. Enum: `created`,`updated`,`removed`

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "created",   "updated"  ] }}
Copy

Create a channelbinding notification rule

Create a channelbinding notification rule for the associated channel with the provider parameters.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of channel binding notifications to subscribe to. Enum: `created`,`updated`,`removed`

POST /channelbindings

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/channelbindings' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "created",      "updated"    ]  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of channel binding notifications to subscribe to. Enum: `created`,`updated`,`removed`

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "created",   "updated"  ] }}
Copy

Deletes a channelbinding notification rule

Deletes the channelbinding notification rule associated with the account.

Auth

DELETE /channelbindings

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/channelbindings'
Copy

Responses

200

Deleted channelbinding rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Trigger a test notification

Trigger a test channelbinding notification with the provided data as the payload, the signature should be omitted as it will be filled by the service.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
operation	string	What type of channelbinding operation was performed. Enum: `created`,`removed`,`updated`

POST /channelbinding/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/channelbinding/test' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "created"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Supplier

Supplier notification rules

Get a supplier notification rule

Get the supplier notification rule associated with the account

Auth

GET /supplier

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/supplier'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of supplier notifications to subscribe to. Enum: `updated`

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Update a supplier notification rule

Update an existing supplier notification rule for the user's channel-id.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of supplier notifications to subscribe to. Enum: `updated`

PUT /supplier

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/supplier' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "updated"    ]  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of supplier notifications to subscribe to. Enum: `updated`

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Create a supplier notification rule

Create a supplier notification rule for the associated channel with the provider parameters.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of supplier notifications to subscribe to. Enum: `updated`

POST /supplier

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/supplier' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "updated"    ]  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of supplier notifications to subscribe to. Enum: `updated`

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Deletes a supplier notification rule

Deletes the supplier notification rule associated with the account.

Auth

DELETE /supplier

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/supplier'
Copy

Responses

200

Deleted supplier rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Trigger a test notification

Trigger a test supplier notification with the provided data as the payload, the signature should be omitted as it will be filled by the service.

Auth

Request Body

object object

supplierID

string

The Booking-API Supplier ID.

operation

string

What type of supplier modification was performed.

Enum: updated

POST /supplier/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/supplier/test' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "updated"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Product

Product notification rules

Get a product notification rule

Get the product notification rule associated with the account

Auth

GET /product

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/product'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of product notification to subscribe to. Enum: `updated`

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Update a product notification rule

Update an existing product notification rule for the user's channel-id.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of product notification to subscribe to. Enum: `updated`

PUT /product

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/product' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "updated"    ]  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of product notification to subscribe to. Enum: `updated`

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Create a product notification rule

Create product notification rule for the associated channel with the provided parameters. Since product visibility is controlled by channel bindings, those interested in new or removed products should subscribe to channel bindings separately.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of product notification to subscribe to. Enum: `updated`

POST /product

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/product' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "updated"    ]  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of product notification to subscribe to. Enum: `updated`

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Deletes a product notification rule

Deletes the product notification rule associated with the account.

Auth

DELETE /product

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/product'
Copy

Responses

200

Deleted product update rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Trigger a test notification

Trigger a test product notification with the provided data as the payload, the signature should be omitted as it will be filled by the service.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
operation	string	The product operation. Since product visibility is controlled by channel bindings, those interested in new and removed products should subscribe to channel bindings. Enum: `updated`

POST /product/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/product/test' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "updated"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Rate

Rate notification rules

Get a rate notification rule

Get the rate notification rule associated with the account

Auth

GET /rate

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/rate'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of rate notification to subscribe to. Enum: `updated`

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Update a rate notification rule

Update an existing rate notification rule for the user's channel-id

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of rate notification to subscribe to. Enum: `updated`

PUT /rate

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/rate' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "updated"    ]  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of rate notification to subscribe to. Enum: `updated`

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Create a rate notification rule

Create rate notification rule for the associated channel with the provided parameters. Since rate visibility is controlled by channel bindings, those interested in new or removed rates should subscribe to channel bindings separately.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of rate notification to subscribe to. Enum: `updated`

POST /rate

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/rate' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "updated"    ]  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of rate notification to subscribe to. Enum: `updated`

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "updated"  ] }}
Copy

Deletes a rate notification rule

Deletes the rate notification rule associated with the account.

Auth

DELETE /rate

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/rate'
Copy

Responses

200

Deleted rate update rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Test a trigger notification

Trigger a test rate notification with the provided data as the payload, the signature should be omitted as it will be filled by the service.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
rateID	string	The Booking-API Rate ID
operation	string	The rate operation. Since rate visibility is controlled by channel bindings, those interested in new and removed rates should subscribe to channel bindings. Enum: `updated`

POST /rate/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/rate/test' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "rateID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "operation": "updated"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Availability

Availability notification rules

Get an availability notification rule

Get the availability notification rule associated with the account

Auth

GET /availability

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/availability'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.
vacanciesUnder	uint32	Used to filter availabilities based on their vacancies, if an availability change does not cause the vacancies to drop below the provided value no notification will be issued. If set to 0 all changes inside the maxLookAheadDays will trigger a notification.

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "maxLookAheadDays": 30,  "vacanciesUnder": 5 }}
Copy

Update an availability notification rule

Update an existing availability notification rule for the user's channel-id.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.
vacanciesUnder	uint32	Used to filter availabilities based on their vacancies, if an availability change does not cause the vacancies to drop below the provided value no notification will be issued. If set to 0 all changes inside the maxLookAheadDays will trigger a notification.

PUT /availability

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/availability' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "maxLookAheadDays": 30,    "vacanciesUnder": 5  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.
vacanciesUnder	uint32	Used to filter availabilities based on their vacancies, if an availability change does not cause the vacancies to drop below the provided value no notification will be issued. If set to 0 all changes inside the maxLookAheadDays will trigger a notification.

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "maxLookAheadDays": 30,  "vacanciesUnder": 5 }}
Copy

Create an availability notification rule

Create an availability notification rule for the associated channel with the provider parameters.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.
vacanciesUnder	uint32	Used to filter availabilities based on their vacancies, if an availability change does not cause the vacancies to drop below the provided value no notification will be issued. If set to 0 all changes inside the maxLookAheadDays will trigger a notification.

POST /availability

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/availability' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "maxLookAheadDays": 30,    "vacanciesUnder": 5  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.
vacanciesUnder	uint32	Used to filter availabilities based on their vacancies, if an availability change does not cause the vacancies to drop below the provided value no notification will be issued. If set to 0 all changes inside the maxLookAheadDays will trigger a notification.

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "maxLookAheadDays": 30,  "vacanciesUnder": 5 }}
Copy

Deletes an availability notification rule

Deletes the availability notification rule associated with the account.

Auth

DELETE /availability

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/availability'
Copy

Responses

200

Deleted availability rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Trigger a test notification

Trigger a test availability notification with the provided data as the payload, the signature should be omitted as it will be filled by the service.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
rateID	string	The Booking-API Rate ID.
start	string	An RFC-3339 start time.
end	string	An RFC-3339 end time.

POST /availability/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/availability/test' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "rateID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "start": "2024-01-18T10:05:15.000Z",  "end": "2024-01-18T10:05:15.000Z"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Priceschedule

PriceSchedule notification rules

Get a priceschedule notification rule

Get the priceschedule notification rule associated with the account

Auth

GET /priceschedule

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/priceschedule'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z"}
Copy

Update a priceschedule notification rule

Update an existing priceschedule notification rule for the user's channel-id.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.

PUT /priceschedule

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/priceschedule' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "maxLookAheadDays": 30  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z"}
Copy

Create a priceschedule notification rule

Create a priceschedule notification rule for the associated channel with the provider parameters.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
maxLookAheadDays	int	Max number of days in the future to consider when determine if an availability change should trigger a notification. Defaults to 7.

POST /priceschedule

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/priceschedule' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "maxLookAheadDays": 30  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z"}
Copy

Deletes a priceschedule notification rule

Deletes the priceschedule notification rule associated with the account.

Auth

DELETE /priceschedule

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/priceschedule'
Copy

Responses

200

Deleted priceschedule rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Trigger a test notification

Trigger a test price schedule notification with the provided data as the payload, the signature should be omitted s it will be filled by the service.

Auth

Request Body

object	object
supplierID	string	The Booking-API Supplier ID.
productID	string	The Booking-API Product ID.
start	string	An RFC-3339 start time.
end	string	An RFC-3339 end time.

POST /priceschedule/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/priceschedule/test' \ --data '{  "supplierID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "productID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "start": "2024-01-18T10:05:15.000Z",  "end": "2024-01-18T10:05:15.000Z"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Booking

Booking notification rules

Get a booking notification rule

Get the booking notification rule associated with the account

Auth

GET /booking

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/booking'
Copy

Responses

200

Rule found

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of booking notification to subscribe to. Enum: `canceled`,`tickets-added`

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "canceled",   "tickets-added"  ] }}
Copy

Update a booking notification rule

Update an existing booking notification rule for the user's channel-id.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of booking notification to subscribe to. Enum: `canceled`,`tickets-added`

PUT /booking

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/booking' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "canceled",      "tickets-added"    ]  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of booking notification to subscribe to. Enum: `canceled`,`tickets-added`

400

Malformed rule

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "canceled",   "tickets-added"  ] }}
Copy

Create a booking notification rule

Create a booking notification rule for the associated channel with the provider parameters.

Auth

Request Body

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
config	object
operations	array[string]	The type of booking notification to subscribe to. Enum: `canceled`,`tickets-added`

POST /booking

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/booking' \ --data '{  "url": "https://www.example.com/notification_route",  "disabled": false,  "config": {    "operations": [      "canceled",      "tickets-added"    ]  }}'
Copy

Responses

201

Rule created

object	object
url	string	The URL for a notification to be posted to, each subscribed notification type should have a unique URL, eg: https://www.example.com/availability https://www.example.com/channelbindings
disabled	boolean	Whether this rule is disabled or not (defaults to false).
securityKey	string	A generated security key to authenticate the origin of a notification. This is generated by us and can be used along with a full notification signature to verify the message origin, part of the notification spec.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created
config	object
operations	array[string]	The type of booking notification to subscribe to. Enum: `canceled`,`tickets-added`

400

Malformed rule

409

Rule already exists

Response

xxxxxxxxxx
 
{ "url": "https://www.example.com/notification_route", "disabled": false, "securityKey": "f6d1d681-5b9e-48a8-8298-b69892eecf0c", "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z", "config": {  "operations": [   "canceled",   "tickets-added"  ] }}
Copy

Deletes a booking notification rule

Deletes the booking notification rule associated with the account.

Auth

DELETE /booking

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/booking'
Copy

Responses

200

Deleted booking rule

No response body

404

Rule not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Trigger a test notification

Trigger a test booking notification with the provided data as the payload, the signature should be omitted as it will be filled by the service.

Auth

Request Body

object	object
bookingID	string	The Booking-API Booking ID.
startTime	string	The booking start time.
resellerBookingReference	string	The reseller booking reference, if available.
operation	string	The booking operation Enum: `canceled`

POST /booking/test

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/booking/test' \ --data '{  "bookingID": "65cddcad-b3e0-4fd9-a466-7188104742a2",  "startTime": "2024-01-18T10:05:15.000Z",  "resellerBookingReference": "BR0987654321",  "operation": "canceled"}'
Copy

Responses

200

Notification processed.

No response body

400

Malformed or invalid request.

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy

Metadata

Notification Metadata

Get a metadata object

Get the metadata object associated with the account.

Auth

GET /metadata

xxxxxxxxxx
 
curl --get \ --url 'https://notifications.redeam.io/registry/v1/metadata'
Copy

Responses

200

Object found

object	object
throttleDelay	string	A delay applied before sending notifications, can be useful to spread out load a bit. Uses a duration string; a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel. This can be used to stop all notifications without modifying each rule individually. In the event a backend queue for a subscriber reaches the max size (indicating no notification are being received (all are in a state of retry) the system will trigger an alert to our devops staff and disable the queue using this disableAll parameter. Notifications can be re-enabled (via an update this value) after the cause has been addressed.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

404

Object not found

500

Internal error

Response

xxxxxxxxxx
 
{ "throttleDelay": "10s", "disableAll": false, "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z"}
Copy

Update a metadata object

Update the metadata object associated with the account.

Auth

Request Body

object	object
throttleDelay	string	A delay applied before sending notifications, can be useful to spread out load a bit. Uses a duration string; a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel. This can be used to stop all notifications without modifying each rule individually. In the event a backend queue for a subscriber reaches the max size (indicating no notification are being received (all are in a state of retry) the system will trigger an alert to our devops staff and disable the queue using this disableAll parameter. Notifications can be re-enabled (via an update this value) after the cause has been addressed.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

PUT /metadata

xxxxxxxxxx
 
curl --request PUT \ --url 'https://notifications.redeam.io/registry/v1/metadata' \ --data '{  "throttleDelay": "10s",  "disableAll": false,  "updatedOn": "2024-01-18T10:05:15Z",  "createdOn": "2024-01-18T10:05:15Z"}'
Copy

Responses

200

Object updated

object	object
throttleDelay	string	A delay applied before sending notifications, can be useful to spread out load a bit. Uses a duration string; a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel. This can be used to stop all notifications without modifying each rule individually. In the event a backend queue for a subscriber reaches the max size (indicating no notification are being received (all are in a state of retry) the system will trigger an alert to our devops staff and disable the queue using this disableAll parameter. Notifications can be re-enabled (via an update this value) after the cause has been addressed.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

400

Malformed object

404

Object not found

500

Internal error

Response

xxxxxxxxxx
 
{ "throttleDelay": "10s", "disableAll": false, "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z"}
Copy

Create a metadata object

Metadata stores modifiers applied across all notification webhooks for a given consumer.

Auth

Request Body

object	object
throttleDelay	string	A delay applied before sending notifications, can be useful to spread out load a bit. Uses a duration string; a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel. This can be used to stop all notifications without modifying each rule individually. In the event a backend queue for a subscriber reaches the max size (indicating no notification are being received (all are in a state of retry) the system will trigger an alert to our devops staff and disable the queue using this disableAll parameter. Notifications can be re-enabled (via an update this value) after the cause has been addressed.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

POST /metadata

xxxxxxxxxx
 
curl --request POST \ --url 'https://notifications.redeam.io/registry/v1/metadata' \ --data '{  "throttleDelay": "10s",  "disableAll": false,  "updatedOn": "2024-01-18T10:05:15Z",  "createdOn": "2024-01-18T10:05:15Z"}'
Copy

Responses

201

Created

object	object
throttleDelay	string	A delay applied before sending notifications, can be useful to spread out load a bit. Uses a duration string; a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms" or "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel. This can be used to stop all notifications without modifying each rule individually. In the event a backend queue for a subscriber reaches the max size (indicating no notification are being received (all are in a state of retry) the system will trigger an alert to our devops staff and disable the queue using this disableAll parameter. Notifications can be re-enabled (via an update this value) after the cause has been addressed.
updatedOn	string	A timestamp containing the last time this rule was updated
createdOn	string	A timestamp containing when the rule was created

400

Malformed object

409

Object already exists

Response

xxxxxxxxxx
 
{ "throttleDelay": "10s", "disableAll": false, "updatedOn": "2024-01-18T10:05:15Z", "createdOn": "2024-01-18T10:05:15Z"}
Copy

Delete a metadata object.

Delete the metadata object associated with the account.

Auth

DELETE /metadata

xxxxxxxxxx
 
curl --request DELETE \ --url 'https://notifications.redeam.io/registry/v1/metadata'
Copy

Responses

200

Deleted metadata object

No response body

404

Object not found

500

Internal error

Response

xxxxxxxxxx
 
No response
Copy