Cubu Docs
Technical Guide
Technical Guide
  • Welcome to Cubu's Technical Guide!
  • White Papers
    • Data Protection
    • Sign On and Authentication
  • Advanced Configuration
    • Configuring Video Meetings
      • ⚒️Using Microsoft Teams for Video Meetings
      • ⚒️Using Zoom for Online Meetings
    • Calendar Integration
      • ⚒️Configuring Microsoft Office 365 Calendar Integration
      • ⚒️Configuring Google Workspace Calendar Integration
    • Configuring Single Sign On (SSO)
      • ⚒️Configuring SSO with Azure AD
      • ⚒️Configuring SSO with Okta
      • ⚒️Configuring SSO with Auth0
    • Configuring Chatbots
      • Configure Chatbot using WhatsApp
  • Webhooks
    • Webhooks Configuration
    • Developing Webhooks
      • Dev Tools
      • HMAC Validation (ASP.NET Core)
    • Webhooks Reference
      • Organization Webhooks
        • 🪝Webhook: Send SMS
      • Data Table Webhooks
        • 🪝Webhook: Query
        • 🪝Webhook: Find
        • 🪝Webhook: Fetch
      • Service Webhooks
        • 🪝After Book Appointment
        • 🪝After Check In
        • 🪝After Close
        • 🪝Before Book Appointment
        • 🪝Before Check In
        • 🪝Before Queue-Up
        • 🪝Before Resolve
        • 🪝After Queue-up
        • 🪝After Resolve
        • 🪝After Start Work
      • Kiosk Webhooks
        • 🪝Before Query Appointments
  • Server to Server (S2S) API
    • Server to Server (S2S) API
Powered by GitBook
On this page
  • Overview
  • API
  • Request Body
  • Response Body
  1. Webhooks
  2. Webhooks Reference
  3. Kiosk Webhooks

Before Query Appointments

Run custom code when checking in on the kiosk

Overview

The webhook is called when a customer uses the kiosk to check in to an appointment by entering a customer ID. (The "Check-In with customer ID" option must be enabled on the Kiosk).

Calling webhooks before searching for customer appointments in calendars allows you to use Cubu's S2S API to create ad-hoc appointments for the customer.

API

[base-url]/kiosk/actions/beforeQueryAppointments

Request Body

  • queryType: Supported values: CustomerId

  • unitId: The kiosk’s parent unit Id

  • kioskId: The ID of the kiosk which triggered the webhook.

  • customerId: The ID entered by the customer on the Kiosk

  • locale: The kiosk’s selected language

  • timeZoneId: The kiosk partner unit’s time zone

Response Body

This webhook does not return any data.

PreviousKiosk WebhooksNextServer to Server (S2S) API

Last updated 1 year ago

🪝