FeaturesPricingUse CasesIntegrationsCompareLog inGet started free
REST API

Install Supportson on REST API

Programmatic access for custom integrations

Build custom integrations with the Supportson REST API. Send and receive messages programmatically, manage conversations, and receive webhooks for events. Ideal for connecting Supportson to your CRM, helpdesk, or custom backend.

Setup time: 10 minutes
1

Your widget embed code

Replace YOUR_AGENT_ID with your actual Agent ID from the Supportson dashboard.

<script src="https://supportson.com/widget.js" data-agent="YOUR_AGENT_ID" defer></script>

Step-by-Step Installation

1

Get your API credentials

Log in to your Supportson dashboard and go to Settings > API. Generate an API key and note your Account ID.

2

Send a message via API

Use the conversations endpoint to send messages programmatically.

curl -X POST https://supportson.com/api/messages \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "conversation_id": "conv_abc123",
    "content": "Hello from the API!",
    "role": "agent"
  }'
3

List conversations

Retrieve all conversations for your account.

curl https://supportson.com/api/conversations \
  -H "Authorization: Bearer YOUR_API_KEY"
4

Embed the widget with your agent

The widget script tag works alongside the API. Install it on your site to capture visitor conversations, then manage them via API.

<script src="https://supportson.com/widget.js" data-agent="YOUR_AGENT_ID" defer></script>
5

Set up webhooks (optional)

Configure webhook URLs in your dashboard under Settings > Webhooks to receive real-time notifications for new messages, conversations, and events.

Verify Your Installation

  1. Open your website in a browser (use an incognito window to avoid caching issues).
  2. Look for the Supportson chat bubble in the bottom-right corner of the page.
  3. Click the bubble to open the chat widget and send a test message.
  4. Check your Supportson dashboard — the conversation should appear in real time.

Not seeing the widget? Make sure you replaced YOUR_AGENT_ID with your actual Agent ID, and that the script tag is placed before the closing </body> tag.

What You Get With REST API

✓RESTful JSON API
✓Webhook notifications
✓Conversation management
✓Message send and receive
✓API key authentication

Popular Use Cases

Add Supportson to REST API today

Set up in 10 minutes. No credit card required.