Partner booking

For booking platforms that send patients to Kaddio care providers and need to know when a booking is confirmed.

In the examples, replace values in capitals, such as YOUR_ORG and YOUR_API_TOKEN, with your own.

When people find a Kaddio care provider through your platform and book with them, Kaddio sends a webhook to you when the booking is confirmed.

Webhooks are sent for bookings made by visitors who are not signed in to Kaddio and that have a booking reference.

Set up #

  1. Contact Kaddio support to register as a partner. Send us your webhook URL, any authentication headers you want us to send, and your expected booking volume. You get a partner ID.
  2. Build a webhook endpoint that accepts POST requests with JSON.
  3. Send visitors to the care provider's booking page with your booking reference.

Booking reference #

Start every reference with your partner ID and an underscore, for example yourcompany_ABC123.

Send the visitor to the care provider's booking page with the reference in bookingref:

https://YOUR_ORG.kaddio.com/booking/cal?bookingref=yourcompany_ABC123

You can combine it with the other booking link parameters, for example to preselect a practitioner or prefill the visitor's details.

The webhook #

When the booking is confirmed, Kaddio sends:

POST https://api.yourcompany.com/webhooks/kaddio
Content-Type: application/json

{
  "SourceSystem": "Kaddio",
  "CareProvider": "https://example.kaddio.com",
  "AdditionalInfo": "yourcompany_ABC123",
  "ExternalBookingId": "Hd6jK9mN2pQ5rS8tU"
}
Field Content
SourceSystem Always Kaddio
CareProvider The care provider's Kaddio address
AdditionalInfo Your booking reference, with the prefix
ExternalBookingId Kaddio's ID for the booking

Any headers you registered, such as an API key, are sent with every request.

Example #

app.post('/webhooks/kaddio', (req, res) => {
    const { AdditionalInfo, ExternalBookingId } = req.body;
    const reference = AdditionalInfo.slice(AdditionalInfo.indexOf('_') + 1);

    updateBookingStatus(reference, {
        status: 'confirmed',
        kaddioBookingId: ExternalBookingId
    });

    res.status(200).json({ received: true });
});

The booking is confirmed even if your webhook fails, so monitor your endpoint.

Questions? Ask the help assistant here on the site, or ask Kaddio AI inside Kaddio. You can also contact support.