Notifications API
Send automated messages for booking events to simplify your operations and scale effectively
The Notifications API lets you integrate with the Rapid API more closely than ever. When booking changes occur that can impact your business or operations, the Notifications API will push details of the change directly to all affected parties. Messages can be initiated by agents, vendors, and the Rapid API itself. That means if a call center agent makes a change or a vendor cancels a booking, you'll be notified. Likewise, if the API successfully creates a new booking, you will receive a notification you can use to maintain alignment with your internal systems.
Note: In the Lodging API, we already support messages from agents, vendors, and the Rapid API. In the Car and Activities APIs, we currently support agent-initiated booking changes, and will soon support changes initiated within Rapid API and by our vendors.
The Notifications API enables a seamless integration with your business and complements other partner and customer support services. As we add features and functionality to Rapid API, we'll also add new notification event types to improve your experience.
Event schema and details
All POST notification event adhere to the schema outlined below. As new event types are added for different events the schema may vary.
| Object | Description |
|---|---|
event_id | Unique identifier for each event. |
event_type | An indication of what event caused the notification. This value can be used for message handling and routing. Refer to the list of event types for more information. |
event_time | Timestamp of the event notification given in UTC. |
itinerary_id | The Itinerary ID of the affected booking. |
email | The customer email address associated with the affected itinerary. |
message | Information about the notification event. For events of type itinerary.message.received, this will contain the actual text of the vendor message. In all other event types, this will be a static human friendly description of the event in English. |
affiliate_reference_id | The Affiliate Reference ID of the affected booking. |
topic_tags | The topic tags of the event. These will only be provided on events of type itinerary.message.received. This will be a list of tags that our analysis has determined might be present in the text of the message.>> Learn more about property message tags |
line_of_business | The line of business the event falls into. Possible values: cars, flights, activities, and packages (properties is coming soon). This field does not apply to all event types. Note: This field is currently available for Rapid Car, Flight, and Activities APIs; the Rapid Lodging API has not yet incorporated it. |
Each notification is an HTTPS POST request with a JSON message body.
Note: You’ll need to be enabled for each event type individually to be able to receive those kinds of notifications. If you would like to enable a new Notifications event type, please reach out to support.
Supported event types
The Rapid Notifications service provides proactive messages for the following events. Supported events differ between Rapid lines of business.
API details
Explore the notification-related endpoint definitions on this page, then use the API Explorer or another testing software to get an understanding of how the examples and schema definitions compare to the actual output. We also have a Notification Tester that you can use to test your integration with our Notifications API.