Smart home and automation
Home Assistant, smart locks, webhooks, Node-RED, n8n and telephony.
Call6 Endpoints
- GETReturns a list of SIPCall
- POSTStart a SIPCall
- GETReturns a single SIPCall with the given id
- PUTUpdates a single SIPCall
- PATCHUpdates a single SIPCall
- GETReturns every call that is currently running A call counts as running while it has no hangup and started inside the window configured in iw_call_active_max_age_minutes. The response is deliberately not cached, it has to be current.
HomeAssistant20 Endpoints
- GETReturns a list of bookable resources for Home Assistant.
- GETReturns a calendar feed (iCal) for a single bookable resource.
- GETReturns the iCal for a single booking entry plus its bookable ID.
- POSTRegister a webhook so the ERP notifies Home Assistant when bookings change.
- DELETEUnregister a Home Assistant webhook.
- GETERP smart locks the API key's user may use, for the lock entities of the Home Assistant integration ("Import ERP smart locks", opt-in in Home Assistant). Locks that the calling Home Assistant instance offers itself are left out (excludeHaInstanceId).
- + 14 Endpoints
n8n3 Endpoints
- POSTAn n8n lock trigger offers its locks. Expects JSON body like /api/nodered/smart_lock/register with "delivery": "push" and "webhook_url" (the trigger's production webhook URL).
- DELETEThe lock trigger was deactivated. Expects JSON body {"instance_id": "...", "secret": "..."}.
- POSTAccess check of a reader whose numbers an n8n workflow passes on; same body and answer as /api/nodered/smart_lock/check_access (instance_id + lock_id of a lock trigger, or smart_lock_id).
N8n Webhooks4 Endpoints
Node-RED4 Endpoints
- POSTNode-RED offers its locks. Creates or updates a smart lock connection (provider "nodered"); the locks become smart locks when an administrator syncs the devices of that connection.
- DELETENode-RED stops offering its locks. Expects JSON body {"instance_id": "...", "secret": "..."}.
- POSTResult of a command Node-RED got over MQTT. Expects JSON body {"instance_id": "...", "secret": "...", "success": true, "state": "unlocked", "message": "..."}.
- POSTMay a credential a reader at Node-RED read (app QR code of the lock, member card QR, RFID card number) open the lock? Writes the smart lock log.
SmartLock10 Endpoints
SmartLockConnection7 Endpoints
- GETReturns a list of smart lock connection entries.
- POSTCreates a new smart lock connection entry.
- GETReturns a single smart lock connection entry.
- PUTUpdates an existing smart lock connection entry.
- PATCHUpdates an existing smart lock connection entry.
- POSTStarts the OAuth login with an external provider.
- + 1 Endpoints