API Reference
LoopReply has authenticated dashboard endpoints, widget endpoints, and automation endpoints. They serve different purposes and do not use one interchangeable API key.
Website widget
Use the Agent ID and widget API key from Deploy with the generated browser loader. This key is intended for the widget installation, not administrative access to the Workspace.
Widget installation includes the current script and framework examples.
Automation actions
Configured Zapier and Make connections can use an automation API key for supported actions. The connection must be active in the same Workspace as the target resource.
The automation API expects this header:
X-API-Key: your-automation-api-keyKeep an automation key in your server or automation service. It is different from the browser widget key.
Supported action routes include:
| Method | Route | Purpose |
|---|---|---|
POST | /api/automation/teams/:teamId/conversations/:id/messages | Send a human message to an existing conversation |
POST | /api/automation/teams/:teamId/conversations/:id/tags | Add a conversation tag |
PATCH | /api/automation/teams/:teamId/contacts/:id | Update a contact |
The code identifier teamId means the Workspace ID. Each target conversation or contact must belong to that Workspace. Sending a message is an external action; test with a designated test conversation.
Workflow trigger limitation
The automation route /api/automation/teams/:teamId/agents/:id/trigger is not implemented and returns an error. It does not start an Agent workflow. Sending a human message to a conversation is also not equivalent to triggering an AI response.
Dashboard APIs
The platform’s dashboard uses authenticated user sessions and Workspace permissions. A widget key or automation key does not grant general access to create Agents, change billing, or administer members.
For a custom integration, confirm the endpoint, authentication method, permissions, and request format with support@loopreply.com before depending on a dashboard route as a public API contract.
Errors and request limits
Handle validation failures, authorization errors, and rate limiting in your integration. Use the returned status and error details to diagnose the request. Retry transient failures with backoff; do not blindly retry an action that could send a duplicate message or create a duplicate record.
See Integrations for connection setup and product facts for current capabilities and limits.
Last updated on