Developer docs Β· Zapier
Connect SuperBot to 7,000+ apps
Send new leads, new conversations and escalations from SuperBot to any app on Zapier, and add trained answers or leads to SuperBot from other tools. This page documents the API the integration uses.
Authentication
Create an API key in your dashboard under Integrations β API keys. Only workspace owners and admins can create or revoke keys. A key is shown once; SuperBot stores only its hash. Send it on every request:
X-API-Key: <your SuperBot API key>Test a key, and get the label Zapier shows for the connection:
GET https://superbotapp.ai/api/zapier/meTriggers (REST hooks)
new_leadNew Lead. A lead is captured by your bot or a form.
new_conversationNew Conversation. A visitor starts a new conversation.
conversation_escalatedConversation Escalated to Human. A conversation is handed off to your team.
Subscribe a Zap (target must be a https://hooks.zapier.com URL):
POST https://superbotapp.ai/api/zapier/hooks
{ "event": "new_lead", "target_url": "https://hooks.zapier.com/..." }DELETE https://superbotapp.ai/api/zapier/hooks/{id}Recent records, used for Zap samples, in the same shape as live deliveries:
GET https://superbotapp.ai/api/zapier/triggers/{trigger}?limit=10Leads carry id, name, email, phone, company, source, status, score, message, created_at, dashboard_url. Conversations carry id, visitor_name, visitor_email, message, channel, status, priority, created_at, dashboard_url. Each delivery is signed; a 410 reply from Zapier switches the subscription off.
Actions
POST https://superbotapp.ai/api/zapier/actions/training-answer
{ "question": "Do you ship to Canada?", "answer": "Yes, in 5-8 business days.", "category": "shipping" }question and answer are required; category defaults to general. If the question already exists, its answer is updated instead of duplicated.
POST https://superbotapp.ai/api/zapier/actions/lead
{ "email": "jane@example.com", "name": "Jane", "phone": "", "company": "", "source": "zapier", "status": "new", "notes": "" }A name or email is required; status is one of SuperBot's lead statuses (default new). An existing lead with the same email is returned instead of a duplicate, and leads created this way do not fire the New Lead trigger, so a Zap cannot loop.
Errors and limits
Errors return JSON with a plain-English message: 400 for invalid input, 401 for a missing or revoked key, 404 for an unknown id, and 429 when a key sends too many requests (retry after the Retry-After header). Every request is scoped to the key's own workspace.
Questions
Email support@superbotapp.ai or open a conversation. See our privacy policy for how data is handled.
Automate your support workflow.
Create an API key, then connect SuperBot in Zapier to send leads and escalations wherever your team works.
