API reference

Glimpze exposes a REST API and webhook layer so you can orchestrate live conversations, capture context, and sync data into your existing stack. The reference is being authored now—this outline helps you prepare for the endpoints and behaviors launching with the first release.

• Secure access with project-level API keys and short-lived widget tokens.
• Programmatically start, monitor, and close real-time sessions.
• Push structured lead data into Glimpze and receive lifecycle events back.

Every request to the Glimpze API requires a project API key passed via the Authorization header. Widget sessions exchange a short-lived client token generated from your server to prevent exposure of secret keys in the browser.

• Issue and rotate project API keys from the Glimpze dashboard.
• Mint widget tokens server-side to hydrate visitor sessions with context.
• All traffic is served over HTTPS with TLS 1.2+ enforced.

Session endpoints let you create and manage the real-time conversations that power the Glimpze widget. They are ideal for pre-populating conversations, attaching extra context, or syncing engagement state back into your CRM.

• Create session: initialise a visitor conversation, add labels, and set priority.
• Update session: adjust assignees, append notes, or hand off between teams.
• Close session: mark conversations resolved and trigger downstream automations.

To keep the rest of your stack in sync, the API exposes both push and pull mechanisms. Submit enriched lead data when visitors complete forms, and subscribe to webhooks that fire when conversations start, escalate, or wrap up.

• Use the leads endpoint to store intent data and map it to CRM records.
• Register webhooks for lifecycle moments such as session.created or session.closed.
• Replay webhook deliveries with signed payloads for observability and retries.

Full schemas, sample payloads, and client snippets will publish here soon. Join the early adopter list to be notified the moment the reference goes live.