Module "Webhooks"

With this feature, new, canceled and rescheduled appointments can be transferred automatically to an external application immediately after booking. To do this, the URL of the external application is stored in the settings of the appointment scheduler. The system then sends all appointment and customer data to this URL.

The data is sent via a POST request in JSON format. If required, you can specify a secret key parameter to protect the URL. The parameter is specified in the header of the request.

Events

The event that triggered the webhook call is specified with the header X-Schedule-Organizer-Event. The following events trigger a webhook call:

• New appointment (appointment.new)
• Canceled appointment (appointment.canceled)
• Rescheduled appointment (appointment.rescheduled)

Format

{
    "appointment":{
        "id":"12345",
        "date_time":"2020-12-15 10:30:00",
        "reason":"Appointment reason",
        "calendar":"Calendar",
        "appointment_login_link":"https://calendar.appointmind.net/",
        ...
    },
    "user":{
        "id":"9876",
        "first_name":"Hans",
        "last_name":"Pitt",
        "email":"hans.pitt@example.com",
        "registration_date_time":"2020-12-15 10:30:00",
        ...
    }
}

Show other modules.