Developer Documentation
Everything you need to connect Deskwoot to your stack. Put the chat widget on your site, or drive conversations, contacts and inboxes from your backend.
The REST API lets your own systems create and answer conversations, manage contacts and custom attributes, and react to webhook events. You authenticate with a bearer token from Settings → API Tokens. Every token has its own scopes, so a reporting job can get read access while your back office integration gets write access. API tokens are part of the Enterprise plan.
The JavaScript widget puts Deskwoot live chat on your website. It is one script tag plus a small settings object, and it brings live messaging, file attachments, verified sign in for your logged in users and Fynn, our AI agent. For more control, such as opening the chat from your own button or signing in a user after the page has loaded, the loader adds a small API on window.deskwoot.
New here? Start with the widget: it is one snippet in your page template. Move on to the REST API when you want to sync CRM data or open conversations from your own apps.
JavaScript Chat Widget
Put Deskwoot live chat on your website. Paste one snippet, verify logged in users and open the chat from your own buttons.
- Embed snippet
- Config options
- JavaScript API
- Identity verification
- CSP notes
REST API
Programmatic access to conversations, contacts, inboxes, teams and more. Authenticate with an API token and drive Deskwoot from your backend.
- Authentication
- Conversations
- Contacts
- Inboxes
- Webhooks
Related in the dashboard
Some integrations are set up right in your Deskwoot dashboard:
- Settings → Webhooks
- Subscribe to conversation, message and contact events over HTTP callbacks.
- Settings → Integrations
- Connect Shopify, Stripe, WooCommerce, Slack, Zapier and more.
- Settings → API Tokens
- Create tokens with their own scopes for the REST API.
Missing an integration or need help wiring something up? Reach us at hello@deskwoot.com.
Frequently asked questions
The short answers are here. For anything else, ask Fynn below.
Does Deskwoot have a REST API?
Yes. The REST API covers conversations, messages, contacts, inboxes, agents, teams, labels, custom attributes, automation rules, webhooks and help center articles. The full reference with curl examples is at deskwoot.com/docs/api. API tokens are part of the Enterprise plan.
How do I authenticate API requests?
Create a token under Settings → API Tokens and send it as a bearer token in the Authorization header of every request. Each token belongs to one workspace, has its own scopes (such as read, write or contacts:read) and can be revoked at any time without touching your other tokens.
Are there webhooks for new conversations and messages?
Yes. Deskwoot sends webhooks when a conversation is created, updated, assigned or resolved, when a message is created, when a contact is created or updated, and when a CSAT survey is submitted. You add webhook URLs for the whole workspace under Settings → Webhooks and pick the events for each URL. Every delivery carries an X-Deskwoot-Signature header (HMAC SHA256), so you can check that it came from us.
Is there an OpenAPI spec or Postman collection?
Yes. The OpenAPI 3.1 spec is published at deskwoot.com/openapi.yaml. Import it into Postman, Insomnia or any other OpenAPI tool to browse the endpoints or generate a client in your language.