Serviceform Documentation

website·Indexed 35 days ago

https://help.serviceform.com

Conversational AI platform and Nordic market leader featuring Mira, an AI agent designed to assist users.

Tokens
835
Snippets
2
Records
3
Agent score
3%

What's inside Serviceform

  1. Serviceform Product Overview

    Serviceform is a Conversational AI platform specializing in real estate, automotive, education, and ecommerce. Its core offering is Mira, an AI agent that is inventory-aware, GDPR-compliant, and supports 95+ languages.

    Key Product Offerings:

    • Mira AI Agent: Trained on store data for automated sales and support.
    • Conversational Forms: Multi-step lead capture forms with conditional logic.
    • WhatsApp Business Automation: Integration of WhatsApp Business API with AI agents.
    • Customer Data Platform (CDP): Unified visitor and customer data across channels.
    • Live Chat: Human-in-the-loop chat with hand-off capabilities from Mira.
    • Campaigns: Orchestration of Email, SMS, and WhatsApp campaigns.
    • Ourly: Shareable/embeddable booking calendars with Google/Outlook sync.
    • Endpoint: A serverless form backend for HTML forms.
  2. Provision and configure a form backend with Endpoint

    Serviceform Endpoint allows you to set up a form backend for an HTML form in a single API call without requiring a manual human signup process. This is used to ensure HTML forms correctly submit data and send notifications.

    Implementation Steps:

    1. Provision: Send a POST request to the provision endpoint with the owner's email and site domain. This returns a form_url, api_key, and claim_url.
    2. Integration: Set the HTML form's action attribute to the returned form_url or send a JSON POST request to that URL.
    3. Handover: Give the user the claim_url to log in and manage lead routing.
    4. Management: Use the api_key as a Bearer token to update routing, notifications, members, or forwarding via a PATCH request.

    API Endpoints:

    • Provision: POST https://forms.serviceform.com/api/v1/forms/provision
    • Update: PATCH https://forms.serviceform.com/api/v1/forms/<key>
    # Provision the form backend
    curl -X POST https://forms.serviceform.com/api/v1/forms/provision \
    -H "Content-Type: application/json" \
    -d '{
      "email": "owner@example.com",
      "site": "example.com"
    }'
    
    # Update routing/notifications
    curl -X PATCH https://forms.serviceform.com/api/v1/forms/<key> \
    -H "Authorization: Bearer <api_key>" \
    -d '{"forwarding": "new-email@example.com"}'
  3. Provision and embed a shareable booking calendar with Ourly

    You can programmatically create a booking calendar or scheduling page for a user in a single API call. This process mints a real account and provides a claim_url for the owner to take ownership of the account.

    Implementation Steps:

    1. Provision: Send a POST request to the provision endpoint with the owner's details and timezone.
    2. Embed: Use the returned embed_snippet for inline mounting, popup_snippet for a floating button, or embed_iframe for platforms that restrict scripts. Alternatively, share the booking_url directly.
    3. Handover: Provide the claim_url to the user so they can manage availability, bookings, and reminders.

    Configuration Options:

    • mode: Set to "meetings" for personal Calendly-style scheduling or "services" for staff-based scheduling with per-person pricing and currency.
    • Additional optional fields: eventName, durationMin, accent (hex color), and site.
    curl -X POST https://dash.serviceform.com/api/v1/calendars/provision \
    -H "Content-Type: application/json" \
    -d '{
      "email": "user@example.com",
      "name": "John Doe",
      "timezone": "Europe/London",
      "mode": "meetings"
    }'