Articles in this section

See more

Sandbox - Webhook (TPS Account)

  • Updated

Table of Contents:

Overview

The Webhook section allows your system to receive real-time notifications from Bakuun when key events occur, such as ARI updates or booking changes.

Instead of polling the API repeatedly, webhooks automatically push event data to your configured endpoint URL.

This ensures faster synchronization between your system and Bakuun.

Webhook → Mapping Endpoints

The Mapping Endpoints section allows you to configure how mapping-related data is exchanged between your system and Bakuun.

This is primarily used to synchronize room and rate plan mapping events across platforms, especially for integrations managing multiple properties or large portfolios.

It ensures both systems stay aligned when mappings are created, updated, or modified.

Integration Direction

  • Push → Bakuun sends mapping events to your configured endpoint. Your system receives updates when room or rate plan mappings are changed. 
  • Read → Bakuun listens for mapping-related events sent from your system. This allows your platform to notify Bakuun when mapping updates occur on your side.

Table Reference - Webhook → Mapping Endpoints

Field Description

  1. URL

 The endpoint URL where Bakuun either pushes mapping events to or retrieves mapping data from your system. This must be publicly accessible and properly secured.

  1. API Version

 Displays the API version configured for the endpoint (e.g., V3). Ensure this matches your integration specification.

  1. Method

Defines the data flow direction: 

  • Push – Bakuun sends mapping updates to your system. 
  • Read – Bakuun retrieves mapping data from your system.

  1. Error Rate

 Shows the percentage of failed delivery attempts to the endpoint. A high error rate may indicate authentication issues, endpoint downtime, or incorrect configuration.

  1. Status

Displays the current state of the endpoint:

  • Active (green) – Endpoint is configured and working. 
  • To Set – Endpoint has not yet been configured.
  • Suspended – Endpoint is manually disabled.

  1. Add Endpoint

Click Add Endpoint to create a new mapping endpoint. A modal will appear where you select the method:

  • Push – Bakuun sends mapping updates to your platform.
  • Read – Bakuun retrieves mapping data from your platform. Once selected, click Add to generate the new endpoint row.

  1. Endpoint Action Menu (... icon)

 Provides additional actions for the endpoint, such as editing configuration or suspending the endpoint.

Manage your Mapping endpoints

Clicking the … (ellipsis) icon next to an active endpoint opens advanced management options for that specific URL. These actions allow you to control versioning, activation status, API key security, and endpoint removal.

 

a. Update API Version

Use this option to view or change the API version used for communication with this endpoint.

  • Current Version: Displays the existing version (e.g., V3 – Released 5 Sep 2025).

  • Available Version: Dropdown with older or newer versions available (e.g., V1 – Released 10 Jul 2025).

  • Change log Icons:

    • : Displays the API version details

    • : Links to full change log in a new tab.

    • : Shows change log inline.

  • Click the Update version to save changes.

📌 Always review the change log before upgrading to ensure compatibility with your system.

 

b. Disable/Enable Endpoint

You can update an endpoint between Active and Suspended:

  • Click Disable from the dropdown to suspend the endpoint.

  • Status will change to Suspended.

  • To reactivate, click Activate again from the same dropdown.

📌 Use this when troubleshooting or temporarily halting event flow without deleting the endpoint.

 

c. Expire Key (Roll API Key)

This option is used when rotating credentials for security reasons.

When selected, the Roll API Key modal appears.

Field Explanation
Key (masked) Displays the current API key in masked format.
Last Used Shows when the key was last used, if available.
Expiration Term Select when the current key will expire (e.g., now, 1 hour, 2 hours, 24 hours).
Authentication Requires account password confirmation.
Roll API Key Generates and replaces the key with a new one.

⚠ Once expired, the old API key cannot be used again.

 

d. Delete Endpoint

This option allows you to permanently remove the endpoint from the system.

⚠ This action cannot be undone. Only delete an endpoint if it is no longer required.

Webhook → ARI Endpoints

The ARI Endpoints section is specifically used for Availability, Rates, and Inventory (ARI) data.

Unlike Mapping endpoints, ARI endpoints are designed for Push only, meaning Bakuun sends ARI updates directly to your system.

This is critical for real-time synchronization of:

  • Availability updates 
  • Rate changes 
  • Inventory adjustments

Table Reference - Webhook → ARI Endpoints

Field Description

  1. URL

 The endpoint where Bakuun pushes ARI data (availability, rates, inventory).

  1. API Version

 Displays the ARI API version currently in use.

  1. Method

 Only Push is supported for ARI endpoints.

  1. Error Rate

 Shows the percentage of failed ARI delivery attempts. Useful for monitoring integration stability.

  1. Status

Displays endpoint status:

  • Active – Working and delivering data 
  • To set – Not yet configured 
  • Suspended – Temporarily disabled

  1. Add Endpoint

Opens a modal to create a new ARI endpoint.

When clicking + Add endpoint, a modal appears:

  • Push → Allows Bakuun to send ARI data to your system. 
  • Click Add to generate the endpoint row.

⚠ ARI endpoints do not support Read mode.

  1. Manage (...)

 Opens advanced endpoint management options (version, suspend, expire key, delete).

Manage Your ARI Endpoints

Clicking the … (ellipsis) icon next to a Booking endpoint opens advanced management options.

 

a. Update API Version

You can update/view the version of the API used for communication with this endpoint.

  • Current Version: Displays the existing version (e.g., V3 – Released 5 Sep 2025).

  • Available Version: Dropdown with older or newer versions available (e.g., V1 – Released 10 Jul 2025).

  • Change log Icons:

    • : Displays the API version details.

    • : Links to full change log in a new tab.

    • : Shows change log inline.

  • Click the Update version to save changes.

 

b. Disable/Enable Endpoint

You can update an endpoint between Active and Suspended:

  • Click Disable from the dropdown to suspend the endpoint.

  • Status will change to Suspended.

  • To reactivate, click Activate again from the same dropdown.

Note: Useful for temporarily halting event flow without deleting the endpoint.

 

c. Expire Key

This opens the Roll API Key modal, used when a key rotation is required (e.g., for security reasons)

  • Displays the current masked key (e.g., B8Y6...2504)

  • Displays Last Used information (if any).

  • You must select an Expiration Term for the current key (now, 1 hour, 2 hours or 24 hours)

  • You must authenticate with your account password to proceed.

  • Click Roll API Key to replace the current key with a new one.

Note: Once expired, the old key can no longer be used for authentication.

 

d. Delete

This option allows you to permanently remove the endpoint from the system.

Note: Only use this if the endpoint is no longer needed. This action cannot be undone.

Webhook → Booking Endpoints

The Booking Endpoints section allows you to configure how booking-related events are sent from Bakuun to your system.

This includes reservation lifecycle events such as:

  • New Booking Modify 
  • Booking Cancel Booking 
  • Cancel Room 
  • Multi-Room Reservations

Unlike Mapping endpoints, Booking endpoints are typically used to receive reservation updates in real time via API Push.

Table Reference - Webhook → Booking Endpoints

Field Description

  1. URL

 The endpoint URL where Bakuun will push booking events (e.g., new, modify, cancel).

  1. API Version

 Shows the version of the Booking API currently used by this endpoint (e.g., V3).

  1. Method

 For Booking endpoints, only Push is supported. Bakuun sends booking data to your system.

  1. Error Rate

 Displays the percentage of failed booking delivery attempts. Useful for monitoring booking sync stability.

  1. Status

Indicates whether the endpoint is:

  • Active – Working and connected
  • To set – Not yet configured
  • Suspended – Temporarily disabled

  1. Add Endpoint

 Click + Add endpoint to create a new booking endpoint. A modal will appear allowing you to configure the URL and method.

  1. Manage (...)

 Opens the endpoint management menu (Update Version, Disable/Enable, Expire Key, Delete).

Manage Your Booking Endpoint

Clicking the … (ellipsis) icon next to a Booking endpoint opens advanced management options.

 

a. Update API Version

You can update/view the version of the API used for communication with this endpoint.

  • Current Version: Displays the existing version (e.g., V3 – Released 5 Sep 2025).

  • Available Version: Dropdown with older or newer versions available (e.g., V1 – Released 10 Jul 2025).

  • Changelog Icons:

    • : Displays the API version details

    • : Links to full changelog in a new tab.

    • : Shows changelog inline.

  • Click the Update version to save changes.

     

b. Disable / Enable Endpoint

You can temporarily stop booking event delivery:

  • Click Disable → Status becomes Suspended 
  • Click Activate → Resume booking event delivery

This is useful during maintenance or system updates.

 

c. Expire (Roll) API Key

Used when rotating credentials for security reasons.

You must:

  • Select an expiration term (e.g., now, 1 hour, 2 hours, 24 hours) 
  • Authenticate using your account password 
  • Click Roll API Key

⚠ Once expired, the old key cannot be used for authentication.

 

d. Delete Endpoint

Permanently removes the endpoint from the system.

⚠ This action cannot be undone. Only use if the endpoint is no longer required.

Related articles