Webhooks frá reglum

Regla getur kallað á URL þegar hún virkjast. Þannig fær þitt eigið kerfi strax að vita um atburð, til dæmis hátt hitastig eða aftengingu tækis.

Áður en þú byrjar

• HAM Systems kveikir á webhooks fyrir hvern reikning. Ef appið sýnir Vefkrókar eru ekki virkjaðir fyrir reikninginn þinn skaltu hafa samband við þjónustuver.
• Þú þarft https:// vistfang sem tekur við POST-beiðnum frá internetinu.

Bæta webhook við reglu

1. Opnaðu Valmynd. Í hópnum Verkfæri ýtirðu á Skýjareglur.
2. Opnaðu reglu eða búðu til nýja reglu. Sjá Búa til reglu.
3. Í aðgerðunum ýtirðu á Bæta við aðgerð.
4. Í listanum velurðu Webhook.
5. Í reitinn URL slærðu inn vistfang kerfisins þíns.
6. Ef þú vilt líka kall þegar reglan endurstillist ýtirðu á Bæta við endurstillingaraðgerð og velur Webhook aftur.
7. Ýttu á Vista.

Tölva

Sími

Tölva

Sími

Ef vistfangið er ekki rétt sýnir appið URL er ekki gilt.

Beiðnin

Kerfið sendir POST með JSON-meginmáli (Content-Type: application/json):

{
  "event": "triggered",
  "rule": {
    "id": 4321,
    "name": "Fridge 1 temperature",
    "serialno": "e11:123",
    "this_data": [ { "...": "the rule conditions" } ]
  },
  "device_data": {
    "e11:123": {
      "R": { "T": 912, "GI": 1, "GIC": 0, "GI2": 1, "GI2C": 0 },
      "O": [],
      "S": { "...": "the device settings" }
    }
  },
  "messages": []
}

Reitur	Innihald
event	triggered þegar reglan virkjast. resolved þegar aðgerð Við endurstillingu keyrir.
rule.id, rule.name	Númer og nafn reglunnar
rule.serialno	Tæki reglunnar
rule.this_data	Skilyrði reglunnar
device_data	Núverandi staða hvers tækis reglunnar, eftir raðnúmeri. Sama snið og uppfærslur WebSocket.
messages	Villur, til dæmis Failed to get state of e11:123 for rule #4321 þegar staða tækis er ekki tiltæk

Gildin í R eru óunnin. Í dæminu merkir T: 912 9,12 °C. Sjá skilgreiningarnar í REST API.

Kerfið fjarlægir WiFi-upplýsingar tækisins (netnafn, lykilorð og fyrirtækjaupplýsingar) úr device_data.

Tryggðu webhook-ið

Beiðnin hefur enga undirskrift (HMAC). Til að athuga að beiðnin komi frá reglunni þinni:

1. Búðu til langt handahófskennt leyndarmál, til dæmis með openssl rand -hex 32.
2. Settu leyndarmálið í fyrirspurnarstreng vistfangsins: https://example.com/ham-hook?token=YOUR_SECRET.
3. Í kerfinu þínu hafnarðu hverri beiðni sem hefur ekki rétt token.

Varúð

Allir sem geta séð regluna geta líka séð vistfangið með leyndarmálinu. Ef þeir sem hafa aðgang breytast skiptirðu um leyndarmál.

Reglur og takmörk

• Vistfangið verður að byrja á https://.
• Kerfið kallar ekki á staðbundin vistföng og einkavistföng: localhost, 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 169.254.0.0/16, 100.64.0.0/10, 0.0.0.0/8 og tengd IPv6-vistföng (::1, fe80:, fc00::/7).
• Allt að 5 köll á hverjum 60 sekúndum fyrir hverja webhook-aðgerð reglu.
• Allt að 30 webhook-köll á hverjum 60 sekúndum fyrir hvern reikning.
• Kerfið sleppir köllunum yfir mörkunum. Það sendir þau ekki síðar.
• Kerfið athugar ekki HTTP-stöðu svarsins þíns og sendir beiðnina ekki aftur.
• Aðgerð getur haft töf (EFTIR). Regla hefur allt að 12 aðgerðir samtals.

Prófun

Fyrir fyrstu prófun notarðu opinbera þjónustu sem sýnir beiðnirnar sem hún tekur við. Búðu til reglu með einföldu skilyrði og skoðaðu meginmál beiðninnar.

Sjá líka

• Hvað regla gerir: viðvörun eða skipun
• Gögn í rauntíma (WebSocket)
• Öryggi