Ienākošie webhooki

Ienākošie webhooki ļauj ārējiem rīkiem ievietot automātiskus ziņojumus HansaChat kanālā. Izmantojiet tos izvietošanas atjauninājumiem, uzraudzības brīdinājumiem, biļešu paziņojumiem, formu iesniegumiem un citiem notikumiem, kuriem jāparādās komandas tērzēšanā.

Ienākošos webhookus var izveidot un pārvaldīt tikai darbavietu administratori.

Izveidojiet webhooku

1. Atveriet Iestatījumi no apakšējās kreisās sānu joslas daļas.
2. Atlasiet Webhooki.
3. Izvēlieties Izveidot webhooku.
4. Ievadiet skaidru webhooka nosaukumu, piemēram, CI Deployments.
5. Izvēlieties kanālu, kurā ziņojumi jāpublicē.
6. Neobligāti ievadiet ikonas URL.
7. Izvēlieties Izveidot webhooku.

Nokopējiet webhooka URL

Pēc izveides HansaChat parāda webhooka URL tikai vienreiz. Nokopējiet to un uzglabājiet drošībā ārējā rīkā, kas sūtīs notikumus.

Ja aizverat šo ekrānu, nesaglabājot URL, nomainiet URL, lai ģenerētu jaunu slepeno atslēgu. Iepriekšējais URL pārstāj darboties uzreiz pēc nomaiņas.

Pārvaldiet webhookus

No webhooku lapas administratori var:

• Rediģēt webhooka nosaukumu, kanālu, ikonas URL vai aktīvo stāvokli.
• Atspējot webhooku, lai noraidītu jaunus ziņojumus, to nedzēšot.
• Nomainīt URL, lai atspēkotu veco slepeno atslēgu un ģenerētu jaunu URL.
• Dzēst webhooku. Esošie tērzēšanas ziņojumi netiek noņemti.

Tehniskā atsauce

Nosūtiet POST pieprasījumu uz webhooka URL:

https://{workspace-domain}/api/webhooks/{publicID}/{secret}

URL satur webhooka pieteikšanās datus. Papildu autentifikācijas galvene nav nepieciešama. Turiet pilnu URL slepenībā.

Minimāls pieprasījums

curl -X POST 'https://{workspace-domain}/api/webhooks/{publicID}/{secret}' \
  -H 'Content-Type: application/json' \
  -d '{"text":"Deployment completed successfully"}'

Kad HansaChat atgriež ok, ziņojums parādās izvēlētajā kanālā.

Ar Slack saderīgs payload

Galapunkts pieņem ar Slack saderīgas JSON slodzes ar text, blocks un attachments.

{
  "text": "Deployment completed successfully",
  "blocks": [
    {
      "type": "header",
      "text": {
        "type": "plain_text",
        "text": "Deployment completed"
      }
    },
    {
      "type": "section",
      "text": {
        "type": "mrkdwn",
        "text": "Branch `main` is now live."
      }
    }
  ]
}

Kaut vienam no text, blocks vai attachments jāsatur salasāms teksts.

Atbalstītie lauki

Maksimālais payload izmērs ir 1 MB.

Pieprasījumu ierobežojumi

Ienākošo webhooku uzņemšana ir ierobežota katram webhooka URL atsevišķi.

Katrs webhooks var pieņemt līdz 10 autentificētiem pieprasījumiem minūtē un līdz 100 autentificētiem pieprasījumiem stundā. Kad kāds no ierobežojumiem ir sasniegts, HansaChat atgriež 429 resource_exhausted.

Lūdzu, sazinieties ar mums, ja vēlaties paaugstināt pieprasījumu ierobežojumu.

Payload ierobežojumi tiek piemēroti atsevišķi: maksimālais pamatteksta izmērs ir 1 MB, blocks pieņem līdz 50 vienībām, attachments pieņem līdz 100 vienībām, un payload jāsatur salasāms teksts.

Idempotence

Pievienojiet Idempotency-Key galveni, kad jūsu sistēma var atkārtoti nosūtīt vienu un to pašu notikumu:

curl -X POST 'https://{workspace-domain}/api/webhooks/{publicID}/{secret}' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: deploy-1247' \
  -d '{"text":"Deployment #1247 completed"}'

Ja HansaChat vienam un tam pašam webhookam atkārtoti saņem vienu un to pašu idempotences atslēgu, tas atgriež 200 ok, neizveidojot dublētu ziņojumu.

Atbildes

Veiksmīgi pieprasījumi atgriež:

ok

Biežākās kļūdas:

Drošības ieteikumi

• Ar webhooku URL rīkojieties kā ar parolēm.
• Uzglabājiet URL savas ārējās sistēmas slepeno datu pārvaldniekā.
• Nomainiet URL, ja tas tika atklāts vai pazuda.
• Atspējojiet nelietotos webhookus.
• Katrai ārējai sistēmai izmantojiet atsevišķu webhooku, lai piekļuvi varētu tīri atsaukt.