Build with the REST API
Connect customer profiles, tickets, feature requests, conversation history and widget identity to your own product.
A connection your team can use
Your support experience can carry your own brand while TruCom handles the work behind it. Use the REST API from your backend to connect customer profiles, open tickets, exchange customer ticket replies and collect feature requests.
Your team works on the same records inside TruCom. Your product can read statuses, public replies and feature progress, so customers stay informed without leaving your app.
Make your first request
In your workspace, open Settings / API access. Create an API key with the permissions your integration needs, then copy it to your server’s secret storage. The full key is shown once.
All endpoints use /api/v1/rest on your TruCom application origin. Use HTTPS in production. A key belongs to one workspace and one widget; requests cannot switch workspace using a parameter.
curl "https://trucom.app/api/v1/rest/me" \
-H "Authorization: Bearer $TRUCOM_API_KEY" \
-H "Accept: application/json"Choose the right connection
| Connection | Use it for |
|---|---|
| JavaScript SDK | Widget display, methods, events, customer context and browser integration. |
| REST API | Trusted server requests to sync customers and read conversations. |
| Signed widget identity | A short-lived proof your server gives only to its authenticated customer. |
A consistent JSON contract
Successful responses contain data and meta. Lists include cursor pagination under meta.pagination. Errors contain error.code, error.message and error.details. X-Request-Id helps identify a particular request.
The API returns public ULIDs as resource IDs. Timestamps use ISO 8601. Responses are not cached.
{
"data": {
"workspace": {
"id": "01KEXAMPLEWORKSPACE00000000",
"name": "Your workspace"
},
"widget_id": "01KEXAMPLEWIDGET00000000000",
"scopes": [
"customers:read"
],
"expires_at": "2027-01-24T12:00:00+00:00"
},
"meta": []
}Keep the reference close
The reference describes every supported endpoint, field and response. Import the OpenAPI 3.1 specification into your API client or use it to generate a typed client.