Forms and channel apps
Contact form from your site
Post JSON or a form to /api/forms/<widget key> with email, name, subject, message and optionally custom fields. Add a hidden empty website field as a honeypot. The same origin allowlist as the widget applies.
curl -X POST https://helpbat.officebats.com/api/forms/wk_... \
-H 'content-type: application/json' \
-d '{"email":"[email protected]","name":"Sam","subject":"Question","message":"Hi there"}'
The help center also has a request form at /hc/<brand>/new.
FormsBat
Create a FormsBat channel app in Settings, Channels. It gives you a URL and a signing secret. Each response becomes a ticket with the answers as the first message. The hook expects:
{ "event": "response.created",
"form": { "id": "...", "title": "Bug report" },
"response": { "id": "...", "respondent": { "email": "[email protected]", "name": "Sam" },
"answers": [ { "label": "What happened?", "value": "..." } ] } }
ClipsBat video messages
Paste a ClipsBat video link into a reply or a note and it shows as a player in the ticket, so a customer can show the problem or an agent can walk them through the fix.
Channel apps (plug in channels)
WhatsApp, social network direct messages or a phone system connect through one interface. Create a custom channel app with a delivery URL.
Inbound: POST to /hooks/channel/<app id> with the header X-HelpBat-Signature: t=<unix seconds>,v1=<hex HMAC-SHA256 of "t.body" with the app secret> and the body:
{ "threadId": "conversation-42", "from": { "id": "u1", "name": "Sam", "email": "[email protected]", "phone": "+15551234567" },
"text": "Hello", "subject": "Optional" }
One thread id stays in one ticket until it is closed.
Outbound: agent replies on those tickets are POSTed to your delivery URL with the same signature header: { "event": "reply.created", "threadId", "ticketNumber", "text", "html", "author" }.