Last updated

Configuring Notification subscriptions

This topic provides information on how to configure notification subscriptions using the Provider Portal.

Using the Provider Portal, you can:

  • Manage endpoints for receiving notifications
  • Subscribe to notification types
  • Manage notification holds

Managing endpoints

To receive notifications, you need to add an endpoint that supports token-based authentication. CNS can then use this endpoint to send notifications to you.

You can set up:

  • A single endpoint with multiple resource identifiers. For example:
    • https://api-gateway.com/notifications/v1/payments
    • https://api-gateway.com/notifications/v1/reservations
  • or multiple endpoints for each resource.

Add new endpoint

  1. After you log in to the Provider Portal, go to Administration > Notification Service Settings.
  2. Click Add new endpoint.
  3. Enter the following details:
    1. The endpoint name.
    2. The endpoint URL.
    3. The URL for the authentication server.
    4. Client ID and client secret. We use these credentials to generate a JWT token.
    5. Click Add endpoint & authenticate.

Once you have added an endpoint, you can use the more options icon by the side of the endpoint to:

Update endpoint details

To update an endpoint details:

  1. Click on the more options icon by the side of the endpoint and select Update endpoint details.
  2. Enter the updated endpoint name and the URL and click Save changes. The endpoint name is optional. If left blank, the endpoint name defaults to endpoint ID.

Update authentication

To update the authentication server details that the endpoint uses to authenticate:

  1. Click on the more options icon by the side of the endpoint and select Update authentication.
  2. Enter the authentication server details including the client ID and client secret.
  3. Click Authenticate. CNS checks the provided authentication credentials for validity and saves the details.

Remove endpoint

Note that you cannot remove an endpoint that has existing notification configurations. First remove all configurations that are associated with the endpoint before removing an endpoint.

Once all configurations are removed from the endpoint, click on the more options icon by the side of the endpoint and select Remove endpoint.

Managing notification subscriptions

Add a new configuration to subscribe to a notification type. Adding configurations allows you to receive notifications of specific types.

You subscribe to a notification type by adding a new configuration.

You can choose to use:

  • A single endpoint to receive notifications for multiple notification types.
  • A separate endpoint for each notification type.

The notification metadata identifies the notification type.

Add new configuration

  1. After you log in to the Provider Portal, go to Administration > Notification Service Settings.
  2. Navigate to the appropriate notification type and click Add new configuration.
  3. The notification type is preselected. Select a notification version.
  4. To subscribe to notification from:
    1. Live properties, select All real properties.
    2. Test properties, select All test properties.
  5. Select the endpoint that was already created.
  6. To start receiving notifications, click Yes, turn on. Alternatively, you can click No, leave off if the endpoint is not ready to receive notifications.

Once the authorization token is generated by the Booking.com systems, the status of the configuration will be On.

Update configuration

You can update the configuration details by clicking on the more options icon by the side of the configuration and selecting Update configuration.

Once the authorization token is generated by the Booking.com systems, the status of the configuration will be On.

Remove configuration

To remove a configuration, click on the more options icon by the side of the configuration and select Remove configuration.

Toggle configuration on/off

You can toggle the configuration on or off by clicking on the more options icon by the side of the configuration and selecting Turn on/off configuration. Turning off the configuration stops sending notifications of the type.

Notification holds

You can add, update or release notification holds. Adding a notification hold pauses the delivery of notifications on demand. You can set holds to take effect immediately or at a specific time in the future.

For more information, see Notification holds.