Booking Widget

The booking widget lets website visitors browse your display inventory, select surfaces, choose dates and submit a booking request, and visitors need no CityScreen Deals account to do this. The request arrives inside Deals as an inquiry deal with placeholder pricing, ready for a sales representative to review and price.

The widget is public: anyone who opens a page with the snippet can browse the inventory and submit a request.

Enabling the widget

  1. Open Settings → General → Inventory booking widget.

  2. Click Activate.

On first activation, Deals creates the widget user, the account that widget requests are recorded under. The system displays the widget user’s email address and a one-time password. Save both — the password is never shown again. Leave the widget user unchanged.

Generating and embedding the key

After activation, a key must be generated before the widget can be embedded.

  1. Click Generate key to generate a public token.

  2. Optionally set a custom container element ID or iframe height (the default minimum is 850 px).

  3. Click Copy code to copy the generated HTML snippet.

  4. Paste the snippet into the target website’s HTML.

The snippet contains a <div> container and a <script> tag that references the public token. When the page loads, the script shows the inventory browser inside the container.

What visitors see

The widget presents a map and a list of active displays. Visitors can filter by display type, search by name or location, and select individual surfaces.

Only displays in the Active state are shown. Each display type is limited to 1000 results.

After selecting one or more displays, the visitor opens the request drawer, enters a name and email address, optionally adds a comment, specifies a placement period for each selection, and submits the request.

What a submitted request becomes

When a visitor submits a booking request, Deals creates the following records:

Customer and contact

Matched by name or email to an existing customer. If no match is found, a new customer and contact are created.

Deal

A new deal in the Inquiry stage. The deal is assigned to the widget user.

Proposals

One proposal per display type included in the request.

Periods

One placement period per distinct date range within each proposal. All pricing is set to zero — these are placeholder values that a sales representative must replace with real prices.

After creation, a confirmation email is sent to the visitor.

The sales representative finds the new inquiry deal in the pipeline, fills in actual pricing, and proceeds through the normal deal lifecycle.

A widget request is a deal in the Inquiry stage that is assigned to the widget user and has zero prices.

Revoking access

Two options exist:

Generate a new key

Click Generate key again. The previous token stops working immediately. Any website still using the old embed snippet stops working until the snippet is updated with the new token.

Deactivate the widget

Click Deactivate on the widget settings page. This disables the widget entirely, and the public token stops working.

Permissions

Enabling, configuring, and revoking the booking widget requires the Synchronization settings permission with update access. This is the same permission bucket that governs Settings → Sync.

See Roles & Permissions.