Inkommande och integrationsutlösare
Utöver det OpenAI-kompatibla API:et accepterar AiHummer inkommande meddelanden från kontakter och automatiseringsplattformar, och avger en server-sidig händelseström du kan prenumerera på. Dessa slutpunkter är hur externa system levererar arbete till gatewayen och hur användargränssnitt förblir aktiva.
Inkommande slutpunkter
Inkommande slutpunkter är hur kanalanslutningar och anpassade integrationer skickar ett meddelande till vändmotorn. De är säkrade av en HMAC delad hemlighet skickat i det X-AIHummer-Inbound-Secret huvud (AIHUMMER_INBOUND_SECRET settings-katalognyckel — konfigurerad i administrationsgränssnittet under Hantering → Inställningar eller med aihummer settings set, inte i gateway.env).
| Metod & sökväg | Syfte |
|---|---|
POST /v1/inbound/telegram |
Inkommande payloads för Native Telegram |
POST /v1/inbound/generic |
Generisk inkommande för e-post→webhook, cron och anpassade appar |
POST /v1/inbound/binding/status |
Rapportera kanalbindningsstatus |
Den generisk endpoint är det enklaste sättet att mata in vilken källa som helst till AiHummer. Skicka en liten JSON-body med kanalnamnet, en stabil extern identifierare och meddelandetexten:
curl https://your-aihummer.example/v1/inbound/generic \
-H "X-AIHummer-Inbound-Secret: $AIHUMMER_INBOUND_SECRET" \
-H "Content-Type: application/json" \
-d '{
"channel": "email",
"external_id": "ticket-4821",
"text": "A customer asks whether order #4821 has shipped."
}'
[!NOTE] Den generiska inkommande dispatchern behöver ett standardarbetsområde. Ställ in
AIHUMMER_DEFAULT_WORKSPACE_IDså att inkommande meddelanden kan vidarebefordras.
[!WARNING] Inkommande slutpunkter är inte skyddade av en
ah-API-nyckel — de förlitar sig påX-AIHummer-Inbound-SecretHMAC. Håll den hemligheten borta från klientkod och vrid den om den läcker.
Integreringsutlösare (Zapier / Make)
POST /v1/integrations/trigger är ingångspunkten för lågkodplattformar för automatisering såsom Zapier och Göra. Slutpunkten är avaktiverad som standard: tills AIHUMMER_INBOUND_TRIGGER_SECRET inställningen är konfigurerad svarar den med 501 Not Implemented. Detta är en separera hemlig, skild från AIHUMMER_INBOUND_SECRET; som varje inställningskatalognyckel anges den i administrationsgränssnittet (Hantering → Inställningar) eller med aihummer settings set.
När den är konfigurerad accepterar slutpunkten antingen en X-AIHummer-Signature HMAC eller en bärartoken av formen Authorization: Bearer <the AIHUMMER_INBOUND_TRIGGER_SECRET value>.
curl https://your-aihummer.example/v1/integrations/trigger \
-H "Authorization: Bearer $AIHUMMER_INBOUND_TRIGGER_SECRET" \
-H "Content-Type: application/json" \
-d '{
"channel": "zapier",
"external_id": "lead-99",
"text": "New lead captured from the contact form."
}'
Backend för Admin Sessions
Dessa två rutter är det interna transportlager som behålls för sidan Admin Sessions. De är inte en stödd, inbäddningsbar kundkanal.
| Metod och sökväg | Syfte |
|---|---|
POST /v1/web/session |
Öppna eller återanslut en Admin Sessions-konversation |
GET /v1/web/stream |
Strömma konversationens svar via SSE |
Evenemangsström
GET /v1/events/stream är en återupptagbar Server-Sent Events-flöde av gateway-händelser. Slutpunkten har två hårda krav:
- Den
?workspace_id=<id>parametern är obligatorisk — utan det begäran avvisas med400. En hyresgästsbevakare verifierar att arbetsytan tillhör uppringarens hyresgäst; någon annansworkspace_idavkastning403. - Verifiering krävs — en adminsession (cookie) eller en
ah-API nyckel i enAuthorization: Bearerhuvud. Utan det är svaret401.
Passa en ?since= markör för att fortsätta från där en tidigare anslutning slutade, så att en återanslutning aldrig förlorar händelser.
# Subscribe from the beginning
curl -N -H "Authorization: Bearer ah-..." \
"https://your-aihummer.example/v1/events/stream?workspace_id=<id>"
# Resume after a known cursor
curl -N -H "Authorization: Bearer ah-..." \
"https://your-aihummer.example/v1/events/stream?workspace_id=<id>&since=<cursor>"
[!TIP] Behandla värdet som varje händelse bär som nästa
sincemarkör. På återanslut, spela upp från den där markören för att garantera minst-en-gång-leverans till din konsument.
Vart härnäst
- Text vänder över OpenAI-ytan: Chattkompletteringar.
- Enhetspareing, SSO-federation och protokollytor: Webhooks, SCIM och parkoppling.
- Alla
AIHUMMER_*vred: Miljövariabler.