REST API

The Social Intents REST API lets you access chat data, contacts, offline messages, and widget information programmatically.

Autenticação

All API requests require authentication using your API token. Find your token in Settings > API Keys in your Social Intents dashboard.

Option 1: Token Header

X-SocialIntentsToken: YOUR_API_TOKEN

Option 2: Basic Auth

Authorization: Basic {base64(accountId:apiToken)}

Base URL

https://www.socialintents.com/v1/api

Endpoints

Health Check

GET /api/ping

Returns {"statusCode":"200","status":"PingSuccessful"}

Get Chats

GET /api/chats

Returns answered and missed chats. Supports filtering:

Get Offline Messages

GET /api/offlinemessages

Returns offline messages with the same filter parameters as chats.

Get Missed Chats

GET /api/missedchats

Returns missed chats only, with the same filter parameters.

Get Contacts / Leads

GET /api/contacts

Returns captured leads. Supports date_from, date_to, timezonee app_id filters.

Get Widgets

GET /api/apps

Returns a list of your widgets with ID, name, timezone, and creation date.

Webhook Management

POST /api/apps/{appId}/webhook
DELETE /api/apps/{appId}/webhook/{webhookId}
DELETE /api/webhook/{webhookId}

See Webhooks for details.

Chat Response Format

Each chat object includes:

• id, chatType (Answered/Missed/Offline Message), appId
• visitorFullName, visitorEmail, visitorPhone
• agentName, agentId, agentEmail
• duration, startDate, visits
• page, referrer, ip, location, userAgent
• visitorCustom1 through visitorCustom6, visitorParams
• textBody (plain text transcript), htmlBody (HTML transcript)
• messages[] - array of individual messages with body, nickname, timestamp, type

Rate Limits

API requests are subject to reasonable rate limits. If you receive a 429 response, reduce your request frequency.