Skip to main content

Webhook Endpoint Configuration

Webhook endpoints automate data exchange with external applications. Tourism operators can automatically send booking details to accounting software when a new booking is created, saving time and ensuring accurate financial records.

Hayden Zammit Meaney avatar
Written by Hayden Zammit Meaney
Updated over 2 months ago

Webhook endpoints automate data exchange with external applications. Tourism operators can automatically send booking details to accounting software when a new booking is created, saving time and ensuring accurate financial records. Efficient endpoint configuration maintains data consistency.

Accessing this feature

REQUIRES_DEVELOPER_INPUT - Navigation path needs to be verified and updated.

How to use it

From the Webhooks page, you will see a list of any existing endpoints.

Add New Endpoint

  1. Click the Add Webhook or New Endpoint button. This will open a configuration form.

Configure Endpoint URL

  1. Endpoint URL: Enter the full URL of the external server or application that will receive the webhook payloads. This URL must be publicly accessible and configured to listen for incoming POST requests.

  2. Security: Ensure your endpoint URL uses HTTPS to encrypt data in transit, protecting sensitive information.

Select Events

  1. Choose the specific events that will trigger your webhook. The platform provides a range of event types, such as `booking.created`, `profile.updated`, `payment.failed`, or `product.stock_changed`. Selecting only relevant events minimizes unnecessary traffic and processing on your receiving server, enhancing efficiency.

Add Secret Key (Optional but Recommended)

  1. A secret key is a unique string used to sign the webhook payload. When your endpoint receives a webhook, it can use this key to verify the integrity and authenticity of the request, ensuring it originated from your Tourism Accelerator platform and has not been tampered with.

  2. Generate a strong, random key and securely store it on your receiving server. The platform will include an HMAC signature in the webhook request headers, which your server can then use for checking.

Add Custom Headers (Optional)

  1. You can include custom HTTP headers with your webhook requests. This is useful for passing additional authentication tokens, content types, or other metadata required by your receiving application. Specify header names and their corresponding values.

Test Endpoint

  1. Before activating, use the Send Test Payload feature. This sends a sample webhook payload to your configured URL, allowing you to verify that your receiving server is correctly configured to accept and process the incoming data.

  2. Monitor your server logs to confirm receipt and proper parsing of the test payload. This step is critical for identifying connectivity or parsing issues early.

Save and Activate Endpoint

  1. Once all configurations are complete and testing is successful, click Save or Activate. Your webhook endpoint will now be live and will begin sending payloads for the selected events.

Monitor Webhook Activity

  1. The Webhooks section includes a Logs or Activity tab. Here, you can review the delivery status of each webhook request, including the HTTP status code returned by your endpoint, payload details, and any error messages. Regularly review these logs to ensure successful delivery and resolve any failures.

Edit or Delete Endpoint

  1. To modify an existing webhook, select it from the list, make the necessary changes, and Save.

  2. To remove an endpoint, select it and choose the Delete option. Confirm the action to permanently remove the webhook configuration.

Tips

  • Always use HTTPS for your endpoint URL to encrypt data in transit.

  • Use and verify secret keys to authenticate incoming requests and ensure payloads originate from a trusted source.

  • Configure your receiving endpoint to process duplicate webhook events without causing unintended side effects.

  • Regularly review webhook delivery logs within the Tourism Accelerator platform.

  • Subscribe only to the events that are strictly necessary for your integration.

Need help?

For further assistance, contact us at [email protected]

Did this answer your question?