Trigger Booking Webhook

PHP examples use the PHP Client Library with SimpleXML

Description

object trigger_booking_webhook ( int $booking, string $event, int $channel )

Parameters

$booking

ID number (or UUID) for the booking to notify about

$event

The webhook event to trigger (currently only modified_booking)

$channel

ID number for the channel the booking belongs to

Example

// Set the channel ID
$channel = 3930;
// Which booking to notify about
$booking = 1234;
// The event to trigger
$event = "modified_booking";

// Call TourCMS API, triggering the webhook notification
$result = $tourcms->trigger_booking_webhook($booking, $event, $channel);

// Check the result, will be "OK" if the notification(s) were queued
if ($result->error == "OK") {
    // Print out each webhook URL that was notified
    foreach ($result->webhook_notifications->webhook_url as $url) {
        echo $url . "\n";
    }
} else {
    // Some problem, e.g. NO_MATCHING_DATA / NO_MATCHING_EVENT / UNPROCESSABLE_EVENT
    print $result->error_message;
}

https://www.example.com/webhook

NodeJS examples use the NodeJS Wrapper

Example

TourCMS.triggerBookingWebhook({
  channelId: 3930,
  booking: {
    booking_id: 1234,
    event: "modified_booking"
  },
  callback: function(response) {
    console.log(response.error);
  }
});

OK

Looking for sample code in a different language? TourCMS and community provided API libraries

Implementing yourself? Check the REST info for this endpoint.