Webhook — custom connection
The bot POSTs a JSON payload to your address: {"rig": "…", "text": "…"}. Works with Home Assistant, n8n, Zapier and any custom script.
How to connect
Prepare the receiver
An HTTP(S) endpoint reachable from the rig (public URL). One POST — one notification.
Connect the bot
In Telegram with OCBot:
/notify webhook URL.Check it
/notify test— the receiver gets{"rig":"rig name","text":"test notice"}.
Format and examples
Content-Type: application/json. Request body:
{
"rig": "rig1",
"text": "Card 3: hang, rig reboot"
}Receiver examples:
Home Assistant"webhook" trigger → an alert action / a scenarion8n / Zapier / MakeWebhook node → any actionCustom scriptany server: a POST endpoint, then whatever you wantTest by handcurl -H 'Content-Type: application/json' -d '{"rig":"t","text":"ok"}' URL
What you get per request
Every request carries rig (name) and text (content). Channel errors surface via /notify test. To disable: /notify off webhook. Bot control through the webhook is NOT available — notifications only.
FAQ
http or https URL?
Any URL reachable from the rig; https is strongly recommended for any private system.
The endpoint is down
The bot won't crash: the error is logged and shows in /notify test. Disable the channel during maintenance: /notify off webhook.
Got an unexpected payload
Check the handler: text goes to the "text" field, rig name to "rig" (Content-Type is application/json).
Any delivery guarantee?
No: one attempt with an 8-second timeout. Retries — configure them on the receiver's side, or use ntfy instead.
Terms: connect with /notify …, test with /notify test, disable with /notify off …; full terms and disclaimer are in the guide.
Independent project: not affiliated with Hiveon/HiveOS; their names belong to their owners.