Connect Essential Support to your own product and tools. Create API keys, receive webhooks, link customer accounts, add a Contact Support link that opens a ticket from inside your app, and test everything safely in the Sandbox before you go live.
Articles 12
- Add a Contact Support link in your app that opens a new ticket
Learn to embed a Contact Support link in your app that securely signs customers into a new ticket form using a short-lived JWT token.
- Add a View tickets link to your app
Learn how to add a View tickets link in your app that shows only when a customer has existing tickets, using a server-side API check and single sign-on handoff.
- Create a ticket with the API
Learn how to use your workspace API key to create a support ticket on behalf of a customer by sending a POST request with their email, subject, and message.
- Create and manage API keys
Learn how to create, use, and revoke API keys to let your backend create and read tickets in Essential Support over HTTPS.
- Integrate Essential Support into your app
Learn how to build integrations with Essential Support using API keys, webhooks, the widget, and email intake to create and manage support tickets, verify customers, and sync support events with your app.
- Link customer accounts (account linking)
Learn how to connect customer accounts to tickets so agents see verified customer badges and can jump to customers in your admin using URL templates.
- Read your tickets with the API
Learn how to retrieve individual tickets and list all tickets for a specific customer using the Essential Support API, including message content and metadata.
- See webhook deliveries and retry failures
View webhook delivery attempts and states for each endpoint, understand automatic retry behavior, and learn how to recover disabled endpoints after fixing your receiver.
- Set up webhooks
Learn to set up webhooks that push signed JSON events to your app whenever tickets change, so you can automate tasks like syncing status or notifying channels without polling.
- Store images and files (connect storage)
Learn how to connect object storage providers like Backblaze B2, Cloudflare R2, or Amazon S3 to store ticket attachments securely in your own infrastructure.
- Test your integration in the Sandbox
Learn how to test all your integrations—API, webhooks, SSO, inbound email, and widget—in an isolated sandbox environment without affecting your live workspace.
- Verify webhook signatures
Learn how to verify that webhook deliveries from Essential Support are authentic by checking the X-ES-Signature header against your endpoint's signing secret using HMAC-SHA256.