AIMERICA
☰

Calendar webhooks and API keys

Send booking events to another system with a webhook, or create an API key for a developer.

Video tutorial, 1:11 · English captions · Download the video

Open Calendar, then the Settings tab inside it. Webhooks > Add Webhook: paste the address that should receive the events, tick the events (booking.created, booking.cancelled, booking.rescheduled, event.created, event.cancelled) and press Create. API Keys > Create API Key: give it a label and press Create.

In this video

Step by step

  1. 1

    Owners and admins can connect the calendar to other systems. Open the Settings tab, inside Calendar.

    Click Settings, inside Calendar
  2. 2

    A webhook tells another system the moment something happens, like a new booking. Open Webhooks.

  3. 3

    Add Webhook opens the form.

    Click Add Webhook
  4. 4

    Paste the address that should receive the events.

  5. 5

    Tick the events to send: here, a new booking and a cancelled booking.

    Tick the events
  6. 6

    Create would start sending them. We press Cancel instead, to keep the demo as it is.

  7. 7

    API Keys let a developer use the calendar API.

  8. 8

    Create API Key asks for a label, so you know later what uses the key.

    Click Create API Key
  9. 9

    Name it after the tool that will use it.

  10. 10

    Create shows the key only once, so copy it right away. We cancel here too.

    Shown once: copy it
A new API key is shown only once: copy it straight away and keep it somewhere safe. Only owners and admins see Webhooks and API Keys.

Was this not what you needed? Write to us.

Français