Implementation Guide (v3)
      Back to home
      1. Knowledge Base
      2. Booking Widget
      3. Implementation Guide (v3)

      Acquisition channel

      What is the acquisition channel property, how to use it, how to retrieve it

      The "acquisitionChannel" field allows you to track the source of a booking; it's an optional field that can be passed as a string during booking creation, either using the booking widget v3 or the booking API.

      Use this field to gain insight into the booking distribution across your channels and campaigns.

      How to pass the source with the booking details when creating a booking:

      • Booking Widget v3
        • See here to learn how to pass the acquisitionChannel property when creating a booking. 
      • Booking API 
        • The acquisitionChannel property can be passed in the body of a POST request. See here for more info.
        • See here for relevant API documentation:
      North American hosting region EU hosting region

       

      How to retrieve the booking source

      The acquisition channel can be found in the following:

      • Webhook
        • Included in all appointment and reservation webhook events.
          The “acquisitionChannel” property is at the root of the booking object.
      • API
        • The acquisitionChannel property will be included in the booking object in the following endpoints:
          • Get /Booking
          • Get /Booking/{bookingId}
          • Get /Calendar
          • Put /Booking; included in the response.

      Limitations

      • The booking widget v2 does not support this field; "acquisitionChannel" will be empty for bookings created using BNv2.
      • The acquisition channel value is passed during booking creation, and won't be changed when a booking is edited. Will be included in the webhook data for appointment.updated and reservation.updated

      Specifications

      The acquisitionChannel property string shall comply with the following requirements:

      •  64 characters max (truncated if over 64 characters)
      • Supports the following characters:
        • Numbers, letters 
        • +-.,_= 

      Spaces are not supported

      Examples of valid values:

      • E-commerce
      • Facebook
      • Clienteling_app
      • Line-chat
      • Google_ad-campaign,summer2024