Notification Registry 0.1.0

The Notification Registry API allows clients to register, update, and manage webhook configurations used by Redeam’s Notification service. This is a configuration-time API, typically called once per notification type. It controls which types of events (e.g., channel binding, Product changes, availability updates, bookings, etc.) your system will receive via webhook callbacks. Each notification type (Channel Binding, Supplier, Product, Rate, Availability, Price Schedule, and Booking) is managed independently through its own rule.

Server

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

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

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

Channelbinding

Configure Channel Binding Notification rules to know when Suppliers, Products, or Rates are bound or unbound to your channel. Receive alerts when your visibility to a Product or Supplier changes via channel binding.

Get a channelbinding notification rule

Retrieve the currently configured Channel Binding Notification Rule for your channel. This returns the webhook URL and subscribed operations.

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of channel binding notifications to subscribe to. `created`: Triggered when a new binding is established at the Product level. This could be the first Rate being bound or when the entire Product is newly bound. In a `created` case, you should call all sets of Redeam's APIs to sync the data in your system, this includes GET Suppliers, GET Products, GET Rates, GET Availabilities and GET Price Schedule. `updated`: Triggered when changes are made to bound Products and Rates, such as Rate-level adjustments within an already-bound Product. e.g., You already have a Product (e.g., a tour or experience) bound to your system. Later the Supplier adds a new Rate (like “Early Bird” or “VIP”) under that Product. Since this new Rate becomes part of the existing binding, Redeam will send an updated channel binding notification to reflect that change. In an `updated` case you should consider: Call Get Rates with the corresponding Product ID from the notification Iterate through those Rates to compare them with the ones connected in your system For each NEW Rate call GET Availabilities and GET Price Schedule For each already known Rate, no action is needed If a Rate is missing, it will indicate it's no longer bound ℹ️ Note: At this time, any Rate changes, whether a Rate was `created` or `removed`, will always register as an `update` event as the Rate object is associated to a Product and it's data. `removed`: Triggered when the entire binding is removed. Only happens when it is removed in full, the Product and all the Rates under it. In a `removed` case, you should remove that Product from your system. Enum: `created`,`updated`,`removed`

Expand

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": [   "{array[string]...}"  ] }}
Copy

Update a channelbinding notification rule

Update the existing Channel Binding Notification Rule. You may update the webhook URL and the types of operations to subscribe to.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of channel binding notifications to subscribe to. `created`: Triggered when a new binding is established at the Product level. This could be the first Rate being bound or when the entire Product is newly bound. In a `created` case, you should call all sets of Redeam's APIs to sync the data in your system, this includes GET Suppliers, GET Products, GET Rates, GET Availabilities and GET Price Schedule. `updated`: Triggered when changes are made to bound Products and Rates, such as Rate-level adjustments within an already-bound Product. e.g., You already have a Product (e.g., a tour or experience) bound to your system. Later the Supplier adds a new Rate (like “Early Bird” or “VIP”) under that Product. Since this new Rate becomes part of the existing binding, Redeam will send an updated channel binding notification to reflect that change. In an `updated` case you should consider: Call Get Rates with the corresponding Product ID from the notification Iterate through those Rates to compare them with the ones connected in your system For each NEW Rate call GET Availabilities and GET Price Schedule For each already known Rate, no action is needed If a Rate is missing, it will indicate it's no longer bound ℹ️ Note: At this time, any Rate changes, whether a Rate was `created` or `removed`, will always register as an `update` event as the Rate object is associated to a Product and it's data. `removed`: Triggered when the entire binding is removed. Only happens when it is removed in full, the Product and all the Rates under it. In a `removed` case, you should remove that Product from your system. Enum: `created`,`updated`,`removed`

Expand

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": [      "{array[string]...}"    ]  }}'
Copy

Responses

200

Rule updated

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of channel binding notifications to subscribe to. `created`: Triggered when a new binding is established at the Product level. This could be the first Rate being bound or when the entire Product is newly bound. In a `created` case, you should call all sets of Redeam's APIs to sync the data in your system, this includes GET Suppliers, GET Products, GET Rates, GET Availabilities and GET Price Schedule. `updated`: Triggered when changes are made to bound Products and Rates, such as Rate-level adjustments within an already-bound Product. e.g., You already have a Product (e.g., a tour or experience) bound to your system. Later the Supplier adds a new Rate (like “Early Bird” or “VIP”) under that Product. Since this new Rate becomes part of the existing binding, Redeam will send an updated channel binding notification to reflect that change. In an `updated` case you should consider: Call Get Rates with the corresponding Product ID from the notification Iterate through those Rates to compare them with the ones connected in your system For each NEW Rate call GET Availabilities and GET Price Schedule For each already known Rate, no action is needed If a Rate is missing, it will indicate it's no longer bound ℹ️ Note: At this time, any Rate changes, whether a Rate was `created` or `removed`, will always register as an `update` event as the Rate object is associated to a Product and it's data. `removed`: Triggered when the entire binding is removed. Only happens when it is removed in full, the Product and all the Rates under it. In a `removed` case, you should remove that Product from your system. Enum: `created`,`updated`,`removed`

Expand

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": [   "{array[string]...}"  ] }}
Copy

Create a channelbinding notification rule

This rule subscribes your system to events when Suppliers, Products, or Rates become visible (or are removed) from your channel through binding actions.

Configure the operations array to choose which binding events you want to receive:

created: Triggered when a new binding is established at the Product level. This could be the first Rate being bound or when the entire Product is newly bound.
- In a created case, you should call all sets of Redeam's APIs to sync the data in your system, this includes GET Suppliers, GET Products, GET Rates, GET Availabilities and GET Price Schedule.
updated: Triggered when changes are made to bound Products and Rates, such as Rate-level adjustments within an already-bound Product. e.g., You already have a Product (e.g., a tour or experience) bound to your system. Later the Supplier adds a new Rate (like “Early Bird” or “VIP”) under that Product. Since this new Rate becomes part of the existing binding, Redeam will send an updated channel binding notification to reflect that change.
- In an updated case you should consider:
  - Call Get Rates with the corresponding Product ID from the notification
  - Iterate through those Rates to compare them with the ones connected in your system
  - For each NEW Rate call GET Availabilities and GET Price Schedule
  - For each already known Rate, no action is needed
  - If a Rate is missing, it will indicate it's no longer bound
ℹ️ Note: At this time, any Rate changes, whether a Rate was created or removed, will always register as an update event as the Rate object is associated to a Product and it's data.
removed: Triggered when the entire binding is removed. Only happens when it is removed in full, the Product and all the Rates under it.
- In a removed case, you should remove that Product from your system.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of channel binding notifications to subscribe to. `created`: Triggered when a new binding is established at the Product level. This could be the first Rate being bound or when the entire Product is newly bound. In a `created` case, you should call all sets of Redeam's APIs to sync the data in your system, this includes GET Suppliers, GET Products, GET Rates, GET Availabilities and GET Price Schedule. `updated`: Triggered when changes are made to bound Products and Rates, such as Rate-level adjustments within an already-bound Product. e.g., You already have a Product (e.g., a tour or experience) bound to your system. Later the Supplier adds a new Rate (like “Early Bird” or “VIP”) under that Product. Since this new Rate becomes part of the existing binding, Redeam will send an updated channel binding notification to reflect that change. In an `updated` case you should consider: Call Get Rates with the corresponding Product ID from the notification Iterate through those Rates to compare them with the ones connected in your system For each NEW Rate call GET Availabilities and GET Price Schedule For each already known Rate, no action is needed If a Rate is missing, it will indicate it's no longer bound ℹ️ Note: At this time, any Rate changes, whether a Rate was `created` or `removed`, will always register as an `update` event as the Rate object is associated to a Product and it's data. `removed`: Triggered when the entire binding is removed. Only happens when it is removed in full, the Product and all the Rates under it. In a `removed` case, you should remove that Product from your system. Enum: `created`,`updated`,`removed`

Expand

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": [      "{array[string]...}"    ]  }}'
Copy

Responses

201

Rule created

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of channel binding notifications to subscribe to. `created`: Triggered when a new binding is established at the Product level. This could be the first Rate being bound or when the entire Product is newly bound. In a `created` case, you should call all sets of Redeam's APIs to sync the data in your system, this includes GET Suppliers, GET Products, GET Rates, GET Availabilities and GET Price Schedule. `updated`: Triggered when changes are made to bound Products and Rates, such as Rate-level adjustments within an already-bound Product. e.g., You already have a Product (e.g., a tour or experience) bound to your system. Later the Supplier adds a new Rate (like “Early Bird” or “VIP”) under that Product. Since this new Rate becomes part of the existing binding, Redeam will send an updated channel binding notification to reflect that change. In an `updated` case you should consider: Call Get Rates with the corresponding Product ID from the notification Iterate through those Rates to compare them with the ones connected in your system For each NEW Rate call GET Availabilities and GET Price Schedule For each already known Rate, no action is needed If a Rate is missing, it will indicate it's no longer bound ℹ️ Note: At this time, any Rate changes, whether a Rate was `created` or `removed`, will always register as an `update` event as the Rate object is associated to a Product and it's data. `removed`: Triggered when the entire binding is removed. Only happens when it is removed in full, the Product and all the Rates under it. In a `removed` case, you should remove that Product from your system. Enum: `created`,`updated`,`removed`

Expand

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": [   "{array[string]...}"  ] }}
Copy

Deletes a channelbinding notification rule

Deletes the currently active Channel Binding Notification Rule. No further binding notifications will be sent.

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 Channel Binding notification to your configured webhook endpoint. This is useful for testing integration.

ℹ️ Note: supplierID and productID test parameters can use placeholder values. The signature should be omitted as it will be added automatically by the system.

Auth

Request Body

object	object
supplierID	string	The Reseller-API Supplier ID. Example Supplier ID used for testing purposes. This ID simulates a real supplier-related event and does not need to match a live record.
productID	string	The Reseller-API Product ID. Example Product ID to simulate a Product modification event. This ID does not need to be tied to a real product record during testing.
operation	string	The simulated channel binding operation type to test. 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

Set up a Supplier Notification Rule to receive alerts whenever there are updates to suppliers bound to your system.

Get a supplier notification rule

Retrieve the currently configured Supplier Notification Rule for your system. This shows which supplier operations you are subscribed to (currently only updated type is available) and the configured webhook URL.

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Supplier operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Supplier your system is bound to has been modified (e.g., name, contact info). 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 to modify the webhook URL, if needed. Since only the updated operation is currently supported, the list of subscribed operations cannot be changed.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Supplier operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Supplier your system is bound to has been modified (e.g., name, contact info). 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Supplier operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Supplier your system is bound to has been modified (e.g., name, contact info). 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

This rule currently supports only the updated operation, which notifies your system when a supplier you are bound to has been modified (e.g., name, contact details).

ℹ️ Note: Since supplier visibility is managed through channel bindings, Channel Bindings Notifications are the primary source for tracking newly accessible suppliers..

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Supplier operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Supplier your system is bound to has been modified (e.g., name, contact info). 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Supplier operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Supplier your system is bound to has been modified (e.g., name, contact info). 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 currently active Supplier Notification Rule. No further supplier update notifications will be delivered to your system.

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 to your configured webhook endpoint. This test uses mock data and allows you to validate your integration logic.

ℹ️ Note: supplierID test parameter can use placeholder values. The signature should be omitted as it will be added automatically by the system.

Auth

Request Body

object object

supplierID

string

The Reseller-API Supplier ID. Example Supplier ID used for testing purposes. This ID simulates a real supplier-related event and does not need to match a live record.

operation

string

The Supplier operation to simulate in the test notification.

Currently, only updated is supported.

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

Configure a Product Notification Rule to receive real-time updates on changes to Products bound to your system.

Get a Product notification rule

Retrieve the currently configured Product Notification Rule. This shows the webhook URL and which Product operations your system is subscribed to (currently only updated type is available).

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Product operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Product your system is bound to has been modified (e.g., description, location, or hours of operation). ℹ️ Note: Product visibility is managed through channel bindings. To track new or removed Products, use the Channel Binding Notifications. 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 to modify the webhook URL, if needed. Since only the update operation is currently supported, the list of subscribed operations cannot be changed.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Product operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Product your system is bound to has been modified (e.g., description, location, or hours of operation). ℹ️ Note: Product visibility is managed through channel bindings. To track new or removed Products, use the Channel Binding Notifications. 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Product operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Product your system is bound to has been modified (e.g., description, location, or hours of operation). ℹ️ Note: Product visibility is managed through channel bindings. To track new or removed Products, use the Channel Binding Notifications. 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

This rule currently supports only the updated operation, which notifies your system when a Product you are bound to has been modified (e.g., description, hours of operation, or location).

ℹ️ Note: Product visibility is managed through channel bindings. To track newly available or removed Products, subscribe to Channel Binding notifications.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Product operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Product your system is bound to has been modified (e.g., description, location, or hours of operation). ℹ️ Note: Product visibility is managed through channel bindings. To track new or removed Products, use the Channel Binding Notifications. 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Product operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Product your system is bound to has been modified (e.g., description, location, or hours of operation). ℹ️ Note: Product visibility is managed through channel bindings. To track new or removed Products, use the Channel Binding Notifications. 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

Delete the currently active Product Notification Rule. After deletion, your system will no longer receive Product update notifications.

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 to your registered webhook URL. This is used to validate your system’s ability to receive and process Product update events.

ℹ️ Note: supplierID and productID test parameters can use placeholder values. The signature should be omitted as it will be added automatically by the system.

Auth

Request Body

object	object
supplierID	string	The Reseller-API Supplier ID. Example Supplier ID used for testing purposes. This ID simulates a real supplier-related event and does not need to match a live record.
productID	string	The Reseller-API Product ID. Example Product ID to simulate a Product modification event. This ID does not need to be tied to a real product record during testing.
operation	string	The Product operation to simulate in the test notification. Currently, only `updated` is supported. 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 enable you to receive real-time alerts for updates to Rates bound to your system.

⚠️ Important: Use Price Schedule Notification Rules for price changes.

Get a Rate notification rule

Retrieve the currently configured Rate Notification Rule. This shows the webhook URL and the Rate operations your system is subscribed to (currently only updated type is available).

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Rate operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Rate your system is bound to has been modified (e.g., cancellation policy, holdable, hours or traveler conditions). ℹ️ Note: Rate visibility is managed through channel bindings. To track new or removed Rates, use the Channel Binding Notifications. ⚠️ Important: For pricing updates, use the Price Schedule Notification Rule. 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 to modify the webhook URL, if needed. Since only the update operation is currently supported, the list of subscribed operations cannot be changed.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Rate operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Rate your system is bound to has been modified (e.g., cancellation policy, holdable, hours or traveler conditions). ℹ️ Note: Rate visibility is managed through channel bindings. To track new or removed Rates, use the Channel Binding Notifications. ⚠️ Important: For pricing updates, use the Price Schedule Notification Rule. 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Rate operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Rate your system is bound to has been modified (e.g., cancellation policy, holdable, hours or traveler conditions). ℹ️ Note: Rate visibility is managed through channel bindings. To track new or removed Rates, use the Channel Binding Notifications. ⚠️ Important: For pricing updates, use the Price Schedule Notification Rule. 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

This rule currently supports only the updated operation, which notifies your system when a Rate you are bound to has been modified (e.g.,changes to cancel policies, holdability, hours, or traveler restrictions).

ℹ️ Note: Rate visibility is managed through channel bindings. To track new or removed Rates, use the Channel Binding notifications.

⚠️ Important: For pricing updates, use the Price Schedule Notification Rule.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Rate operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Rate your system is bound to has been modified (e.g., cancellation policy, holdable, hours or traveler conditions). ℹ️ Note: Rate visibility is managed through channel bindings. To track new or removed Rates, use the Channel Binding Notifications. ⚠️ Important: For pricing updates, use the Price Schedule Notification Rule. 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Rate operations to subscribe to. Currently, only `updated` is supported: `updated`: Notifies when a Rate your system is bound to has been modified (e.g., cancellation policy, holdable, hours or traveler conditions). ℹ️ Note: Rate visibility is managed through channel bindings. To track new or removed Rates, use the Channel Binding Notifications. ⚠️ Important: For pricing updates, use the Price Schedule Notification Rule. 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

Delete the currently active Rate Notification Rule. After deletion, your system will no longer receive Rate update notifications.

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 to your registered webhook URL. This is used to validate your system’s ability to receive and process Rate update notifications.

ℹ️ Note: supplierID and productID test parameters can use placeholder values. The signature should be omitted as it will be added automatically by the system.

Auth

Request Body

object	object
supplierID	string	The Reseller-API Supplier ID. Example Supplier ID used for testing purposes. This ID simulates a real supplier-related event and does not need to match a live record.
productID	string	The Reseller-API Product ID. Example Product ID to simulate a Product modification event. This ID does not need to be tied to a real product record during testing.
rateID	string	The Reseller-API Rate ID. Example Rate ID to simulate a Rate modification event. This ID does not need to be tied to a real product record during testing.
operation	string	The Rate operation to simulate in the test notification. Currently, only `updated` is supported. 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

Set up Availability Notification Rules to receive notifications for availability changes, filtered by vacancy thresholds and lookahead windows. Designed to limit noise by notifying only of significant changes. More information and examples can be found on https://docs.redeam.io/notifications-api

Get an availability notification rule

Retrieve the currently configured Availability Notification Rule.

This will return your notification URL and the configuration parameters used to filter availability change notifications.

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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	The number of days into the future to monitor for availability changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days
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. Default: 0

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. You can change your webhook URL or adjust the filtering configuration (maxLookAheadDays, vacanciesUnder).

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
maxLookAheadDays	int	The number of days into the future to monitor for availability changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days
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. Default: 0

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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	The number of days into the future to monitor for availability changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days
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. Default: 0

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

Register an Availability Notification Rule to receive alerts when availability for a Product or Rate changes. Availability notifications help reduce noise by limiting alerts to near-future changes and significant reductions in availability. This rule is not operation-based, instead, it uses configuration parameters to control when a notification is sent.

You can fine-tune notifications using the following config:

maxLookAheadDays: The number of days into the future to monitor for changes (default: 7).
vacanciesUnder: 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 (default: 0).

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
maxLookAheadDays	int	The number of days into the future to monitor for availability changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days
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. Default: 0

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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	The number of days into the future to monitor for availability changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days
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. Default: 0

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

Delete the currently active Availability Notification Rule. After deletion, your system will no longer receive notifications for availability changes.

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 to your configured webhook. This is used to validate your ability to handle availability change events.

ℹ️ Note: supplierID and productID test parameters can use placeholder values. The only exception is time-related parameters, which must be realistic to prevent them from being filtered out. The signature should be omitted as it will be added automatically by the system.

Auth

Request Body

object	object
supplierID	string	The Reseller-API Supplier ID. Example Supplier ID used for testing purposes. This ID simulates a real supplier-related event and does not need to match a live record.
productID	string	The Reseller-API Product ID. Example Product ID to simulate a Product modification event. This ID does not need to be tied to a real product record during testing.
rateID	string	The Reseller-API Rate ID. Example Rate ID to simulate a Rate modification event. This ID does not need to be tied to a real product record during testing.
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

Configure Price Schedule Notification Rules to receive notifications for price changes within a specified future window. Useful for syncing pricing data efficiently.

Get a priceschedule notification rule

Retrieve the currently configured Price Schedule Notification Rule.

This will return your notification URL and the configuration parameters used to filter price change notifications.

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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 Price Schedule Notification Rule. Use this to change the webhook URL or adjust the maxLookAheadDays setting to control which price changes should trigger notifications.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
maxLookAheadDays	int	The number of days into the future to monitor for price changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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

Register a Price Schedule Notification Rule to receive alerts when price data changes for a Product or Rate. This is useful when you want to stay in sync with near-term pricing updates, while ignoring distant future changes that are not immediately relevant. This rule is not based on operations. Instead, it uses configuration parameters to control the notification window.

You can configure:

maxLookAheadDays: The number of days into the future to monitor for price changes (default: 7).

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
maxLookAheadDays	int	The number of days into the future to monitor for price changes. Only changes that fall within this window (relative to today) will be considered for triggering notifications. Default: 7 days

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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

Delete the currently active Price Schedule Notification Rule. Once deleted, your system will no longer receive price change notifications.

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 to your configured webhook. This test helps validate your ability to receive and process price update events.

Auth

Request Body

object	object
supplierID	string	The Reseller-API Supplier ID. Example Supplier ID used for testing purposes. This ID simulates a real supplier-related event and does not need to match a live record.
productID	string	The Reseller-API Product ID. Example Product ID to simulate a Product modification event. This ID does not need to be tied to a real product record during testing.
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

Set up Booking Notification Rules to inform you of booking-related events such as cancellations or ticket confirmations.

Get a booking notification rule

Retrieve the currently configured Booking Notification Rule. This returns the webhook URL and subscribed operations.

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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Booking operations to subscribe to. Configure the `operations` array to choose which binding events you want to receive: `canceled`: A booking has been canceled. `tickets-added`: A set of tickets has been confirmed and attached to the booking following a previously accepted (202) response. 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. Use this to change the webhook URL or modify the subscribed operations (e.g., add or remove canceled or tickets-added).

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Booking operations to subscribe to. Configure the `operations` array to choose which binding events you want to receive: `canceled`: A booking has been canceled. `tickets-added`: A set of tickets has been confirmed and attached to the booking following a previously accepted (202) response. 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Booking operations to subscribe to. Configure the `operations` array to choose which binding events you want to receive: `canceled`: A booking has been canceled. `tickets-added`: A set of tickets has been confirmed and attached to the booking following a previously accepted (202) response. 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

Register a Booking Notification Rule to receive alerts when booking events occur. Booking notifications help you stay in sync with the full booking lifecycle, particularly in workflows where confirmations may be delayed (http 202 responses).

Supported operations:

canceled: A booking has been canceled.
tickets-added: A set of tickets has been confirmed and attached to the booking following a previously accepted (202) response.

Auth

Request Body

object	object
url	string	The `url` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `false`.
config	object
operations	array[string]	List of Booking operations to subscribe to. Configure the `operations` array to choose which binding events you want to receive: `canceled`: A booking has been canceled. `tickets-added`: A set of tickets has been confirmed and attached to the booking following a previously accepted (202) response. 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` is the public HTTPS webhook endpoint where notifications for this rule will be delivered. Each rule should use a distinct `url` tailored to the specific notification type (e.g., Channel Binding, Product, Rate, Booking). https://www.example.com/channelbindings
disabled	boolean	If `true`, this rule is temporarily disabled and will not trigger any notifications. Default is `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]	List of Booking operations to subscribe to. Configure the `operations` array to choose which binding events you want to receive: `canceled`: A booking has been canceled. `tickets-added`: A set of tickets has been confirmed and attached to the booking following a previously accepted (202) response. 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

Delete the currently active Booking Notification Rule. Once deleted, your system will no longer receive booking event notifications.

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 to your configured webhook endpoint. This test helps you validate your ability to handle booking lifecycle events like cancellations or confirmed ticket additions.

ℹ️ Note: Test parameters can use placeholder values. The signature should be omitted as it will be added automatically by the system.

Auth

Request Body

object	object
bookingID	string	The Reseller-API Booking ID.
startTime	string	The booking start time.
resellerBookingReference	string	The Reseller booking reference, if available.
operation	string	The Booking operation to simulate in the test notification. Currently, only `canceled` is supported. 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 configuration applies global delivery settings across all notification rules, such as delaying delivery or temporarily disabling notifications.

Get a metadata object

Retrieve the currentl configured Notification Metadata configuration. This includes the current throttle delay, disable-all status, and timestamps for the last update.

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. This can be useful to spread out load or reduce burst traffic. Uses a duration string format: a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix. Valid time units: `ns` (nanoseconds) `us` / `µs` (microseconds) `ms` (milliseconds) `s` (seconds) `m` (minutes) `h` (hours) Examples: `"300ms"`, `"2h45m"`, `"10s"`
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel, your system in this cacse. This can be used to stop all notifications without modifying each rule individually. In cases where a subscriber’s backend queue reaches its maximum size (indicating that notifications are not being received and all are in a retry state), the system will trigger an alert to our DevOps team and automatically disable the queue using this `disableAll` flag. Notifications can be re-enabled by updating this value back to `false` once the underlying issue has been resolved.
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 an existing Notification Metadata configuration. Use this to adjust the global delivery throttle delay or re-enable notifications after a temporary disable.

Auth

Request Body

object	object
throttleDelay	string	A delay applied before sending notifications. This can be useful to spread out load or reduce burst traffic. Uses a duration string format: a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix. Valid time units: `ns` (nanoseconds) `us` / `µs` (microseconds) `ms` (milliseconds) `s` (seconds) `m` (minutes) `h` (hours) Examples: `"300ms"`, `"2h45m"`, `"10s"`
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel, your system in this cacse. This can be used to stop all notifications without modifying each rule individually. In cases where a subscriber’s backend queue reaches its maximum size (indicating that notifications are not being received and all are in a retry state), the system will trigger an alert to our DevOps team and automatically disable the queue using this `disableAll` flag. Notifications can be re-enabled by updating this value back to `false` once the underlying issue has been resolved.
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. This can be useful to spread out load or reduce burst traffic. Uses a duration string format: a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix. Valid time units: `ns` (nanoseconds) `us` / `µs` (microseconds) `ms` (milliseconds) `s` (seconds) `m` (minutes) `h` (hours) Examples: `"300ms"`, `"2h45m"`, `"10s"`
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel, your system in this cacse. This can be used to stop all notifications without modifying each rule individually. In cases where a subscriber’s backend queue reaches its maximum size (indicating that notifications are not being received and all are in a retry state), the system will trigger an alert to our DevOps team and automatically disable the queue using this `disableAll` flag. Notifications can be re-enabled by updating this value back to `false` once the underlying issue has been resolved.
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

Create a global Notification Metadata configuration object. Metadata settings apply to all notification rules within your account, allowing you to globally delaying delivery or disable notifications without modifying each rule individually.

Supported configuration:

throttleDelay: Apply a delay (e.g., "10s") before delivering each notification.
disableAll: Temporarily stop all notifications from being delivered across all rules.

ℹ️ Only one metadata object may exist per account.

Auth

Request Body

object	object
throttleDelay	string	A delay applied before sending notifications. This can be useful to spread out load or reduce burst traffic. Uses a duration string format: a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix. Valid time units: `ns` (nanoseconds) `us` / `µs` (microseconds) `ms` (milliseconds) `s` (seconds) `m` (minutes) `h` (hours) Examples: `"300ms"`, `"2h45m"`, `"10s"`
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel, your system in this cacse. This can be used to stop all notifications without modifying each rule individually. In cases where a subscriber’s backend queue reaches its maximum size (indicating that notifications are not being received and all are in a retry state), the system will trigger an alert to our DevOps team and automatically disable the queue using this `disableAll` flag. Notifications can be re-enabled by updating this value back to `false` once the underlying issue has been resolved.
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. This can be useful to spread out load or reduce burst traffic. Uses a duration string format: a possibly signed sequence of decimal numbers, each with optional fraction and a unit suffix. Valid time units: `ns` (nanoseconds) `us` / `µs` (microseconds) `ms` (milliseconds) `s` (seconds) `m` (minutes) `h` (hours) Examples: `"300ms"`, `"2h45m"`, `"10s"`
disableAll	boolean	Disable all can be set to ensure no notifications are sent to any subscribed registry rule for the given channel, your system in this cacse. This can be used to stop all notifications without modifying each rule individually. In cases where a subscriber’s backend queue reaches its maximum size (indicating that notifications are not being received and all are in a retry state), the system will trigger an alert to our DevOps team and automatically disable the queue using this `disableAll` flag. Notifications can be re-enabled by updating this value back to `false` once the underlying issue has been resolved.
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 currently active Notification Metadata configuration. This will remove all throttling or disable-all settings for your account. Notifications will resume normal delivery based on individual rule configurations.

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