Webhook no noteikumiem

Noteikums var izsaukt URL, kad tas nostrādā. Tā jūsu sistēma uzreiz uzzina par notikumu, piemēram, augstu temperatūru vai ierīces atvienošanos.

Pirms sākat

• HAM Systems ieslēdz webhook katram kontam atsevišķi. Ja lietotne rāda Jūsu kontam nav iespējoti webhook, sazinieties ar atbalstu.
• Jums vajag https:// adresi, kas pieņem POST pieprasījumus no interneta.

Pievienojiet webhook noteikumam

1. Atveriet Izvēlne. Grupā Rīki pieskarieties Mākoņa noteikumi.
2. Atveriet noteikumu vai izveidojiet jaunu noteikumu. Skatiet Izveidot noteikumu.
3. Darbībās pieskarieties Pievienot darbību.
4. Sarakstā atlasiet Webhook.
5. Laukā URL ievadiet savas sistēmas adresi.
6. Ja jūs vēlaties izsaukumu arī tad, kad noteikums atiestatās, pieskarieties Pievienot atiestatīšanas darbību un vēlreiz atlasiet Webhook.
7. Pieskarieties Saglabāt.

Dators

Tālrunis

Dators

Tālrunis

Ja adrese nav pareiza, lietotne rāda URL nav derīgs.

Pieprasījums

Platforma sūta POST ar JSON pamattekstu (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": []
}

Lauks	Saturs
event	triggered, kad noteikums nostrādā. resolved, kad darbojas darbība ATIESTATOT.
rule.id, rule.name	Noteikuma numurs un nosaukums
rule.serialno	Noteikuma ierīce
rule.this_data	Noteikuma nosacījumi
device_data	Katras noteikuma ierīces pašreizējais stāvoklis ar sērijas numuru kā atslēgu. Tāds pats formāts kā WebSocket atjauninājumiem.
messages	Kļūdas, piemēram, Failed to get state of e11:123 for rule #4321, kad ierīces stāvoklis nav pieejams

Vērtības laukā R ir neapstrādātas. Piemērā T: 912 nozīmē 9.12 °C. Skatiet definīcijas lapā REST API.

Platforma noņem ierīces WiFi datus (tīkla nosaukumu, paroli un uzņēmuma tīkla datus) no device_data.

Aizsargājiet webhook

Pieprasījumam nav paraksta (HMAC). Lai pārbaudītu, ka pieprasījums nāk no jūsu noteikuma:

1. Izveidojiet garu nejaušu noslēpumu, piemēram, ar openssl rand -hex 32.
2. Ielieciet noslēpumu adreses vaicājuma virknē: https://example.com/ham-hook?token=YOUR_SECRET.
3. Savā sistēmā noraidiet katru pieprasījumu, kuram nav pareizā token.

Uzmanību

Visi cilvēki, kas var redzēt noteikumu, var redzēt arī adresi ar noslēpumu. Ja mainās cilvēki ar piekļuvi, nomainiet noslēpumu.

Noteikumi un ierobežojumi

• Adresei jāsākas ar https://.
• Platforma neizsauc lokālas un privātas adreses: 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 un atbilstošās IPv6 adreses (::1, fe80:, fc00::/7).
• Līdz 5 izsaukumiem 60 sekundēs katrai noteikuma webhook darbībai.
• Līdz 30 webhook izsaukumiem 60 sekundēs katram kontam.
• Platforma izlaiž izsaukumus virs ierobežojumiem. Tā tos nesūta vēlāk.
• Platforma nepārbauda jūsu atbildes HTTP statusu un nesūta pieprasījumu vēlreiz.
• Darbībai var būt aizture (PĒC). Noteikumam kopā ir līdz 12 darbībām.

Pārbaude

Pirmajai pārbaudei izmantojiet publisku pakalpojumu, kas rāda saņemtos pieprasījumus. Izveidojiet noteikumu ar vienkāršu nosacījumu un skatiet pieprasījuma pamattekstu.

Skatiet arī

• Ko dara noteikums: brīdinājums vai komanda
• Tiešsaistes dati (WebSocket)
• Drošība