DocumentationDeveloperAPI & Webhooks
v1.0

API & Webhooks

A clean REST API and signed webhooks so SyntrixOne fits into any stack — from no-code Zapier to bespoke pipelines.

Quick start
Setup time
5 minutes
Prerequisites
  • •An API key from Settings → Developer
  • •A tool that can send HTTP (curl, Postman, your app)
Outcomes
  • First authenticated API call
  • Webhook receiving events

Step-by-step walkthrough

Numbered, real-world instructions you can follow today.

1
Create an API key

Settings → Developer → + New key. Choose scopes carefully — least privilege.

2
Make a call

curl -H "Authorization: Bearer SX_..." https://api.syntrixone.com/v1/leads

3
Add a webhook

Pick events (conversation.created, ticket.updated, lead.captured) and provide your HTTPS endpoint.

4
Verify signatures

Each webhook includes an X-SyntrixOne-Signature header — verify with HMAC-SHA256 using your webhook secret.

Watch tutorial
Watch: API quickstart
Video coming soon — bookmark this page or subscribe for the release.

Tips & best practices

Field-tested advice from teams shipping SyntrixOne in production.

  • Rotate keys quarterly.
  • Use idempotency keys on writes to safely retry.

Common issues & troubleshooting

What goes wrong, and exactly how to fix it.

Frequently asked questions

3 answers to the questions teams ask most.

Ready when you are

Get an API key

Estimated setup time: 5 minutes.

Get an API key

Related articles

Keep going — explore the next pieces of SyntrixOne.

Workspace Settings
Workspace-wide configuration: branding, timezone, locale, security, integrations, and AI defaults.
Live Inbox
A unified, omnichannel inbox where humans and AI work side by side — assign, reply, and resolve from one screen.
Leads CRM
A lightweight, drag-and-drop CRM purpose-built for engagement-driven sales — every lead carries its full conversation history.