Get started

Everything below happens in your workspace at app.tickbook.app.

1. Create your workspace

Register, verify your email, and complete onboarding. Onboarding provisions your organization, first inbox, and a widget project scoped to your website’s origin.

2. Install the support widget

Open Settings → Widget, copy your project’s loader snippet, and paste it before </body> on every page where you want the widget:

<script
  defer
  src="https://cdn.tickbook.app/tickbook.js"
  data-project-key="tbpk_your_project_key"
  data-api-url="https://api.tickbook.app"
  data-websocket-url="https://api.tickbook.app/realtime"
></script>

The widget only loads on origins listed in your project’s allowed origins. Add every domain variant you serve (for example both https://example.com and https://www.example.com).

3. Identify signed-in users (optional)

To attach conversations to a known customer instead of an anonymous visitor, generate a signed identity token on your server using your project’s identity secret (Settings → Widget → Identity), then pass it when the page loads:

window.Tickbook?.identify({ identityToken: token });

Tokens are short-lived (60–3600 seconds) and verified server-side, so visitors cannot impersonate each other.

4. Use the REST API (optional)

Create a scoped API key under Settings → Developer and call the API with a bearer token. Keys are shown once and can be revoked at any time.

curl https://api.tickbook.app/v1/organizations/{orgId}/tickets \
  -H "Authorization: Bearer tbk_your_api_key"

Available scopes: ticket:read, ticket:write, contact:read, contact:write, guide:read, report:read, and widget:identity.

5. Receive webhooks (optional)

Register an HTTPS endpoint under Settings → Developer → Webhooks to receive signed ticket.created, message.created, and guide.published events. Verify the signature header with the endpoint secret before trusting a payload; failed deliveries are retried and can be replayed from the dashboard.

Need help?

Email support@tickbook.app — or use the widget on this site once you’ve installed yours.