Webhooki

Stran z nastavitvami webhookov omogoča vpogled, dodajanje, urejanje in brisanje webhookov.

Webhook je metoda za omogočanje komunikacije v realnem času med vašo aplikacijo in zunanjimi storitvami (v tem primeru aplikacija Typless). Deluje kot povratni klic, ki ob določenih dogodkih samodejno pošlje podatke na določen URL. Webhooki omogočajo avtomatizacijo procesov in integracijo z drugimi sistemi.

Ogled webhookov

V podmeniju nastavitev kliknite na gumb Webhooki (stran je na voljo le, če imate v splošnih nastavitvah omogočen način za razvijalce in ste administrator organizacije).

Glavni pogled prikazuje tabelo obstoječih webhookov s sledečimi stolpci:

• URL: Ciljni naslov, kamor se pošljejo podatki ob sproženem dogodku.

• Čas nastanka: Datum, ko je bil webhook ustvarjen.

• Aktiven: Stanje aktivnosti webhooka - ali je trenutno omogočen ali ne.

• Urejanje: Možnosti urejanja webhooka.

Dodajanje novega webhooka

1. Pritisnite na Dodaj webhook + zgoraj desno v tabeli.

2. Odpre se vam okno, kamor vpišete vse potrebne informacije:

• URL prejemnika: kam bo povratni klic poslan

• Izbira poslovnih enot, za katere bo se bodo pošiljali povratni klici

Dodajanje novega webhooka

1. Kliknite gumb Shrani.

Urejanje webhookov

1. Izberite webhook, ki ga želite urediti s klikom na gumb Uredi.

1. Prikaže se vam obrazec za urejanje.

1. Kliknite gumb Shrani in ta webhook bo nemudoma posodobljen.

Brisanje webhookov

1. Znotraj razdelka Urejanje izberete Izbriši.

2. Prikaže se potrditveno okno za brisanje, kjer lahko akcijo potrdite oziroma ovržete.

Prikaži klice webhooka

1. Znotraj razdelka Urejanje izberete Prikaži klice.

2. Prikaže se vam tabela vseh klicev za ta webhook.

1. Za posamezni webhook klic lahko preverite, kakšna je bila njegova vsebina (oko znotraj stolpca Urejanje) ali klic ponovno sprožite (okrogla puščica znotraj stolpca Urejanje).

Primer vsebine webhooka

Uporaba webhookov

Ko ustvarite webhook, bo ta ob določenem dogodku samodejno pošiljal podatke na določen URL. Trenutno se webhook sproži, ko se za določen dokument zaključi ekstrakcija podatkov.

Webhook pošilja podatke v JSON formatu, ki vsebuje informacije o dogodku. Prejemnik mora biti sposoben obdelati te podatke in ustrezno odreagirati.

Vsebina podatkov je sledeče oblike:

{
  "inv_key": "019547e2-xxxx-xxxx-xxxx-ea1965d68a91",
  "status": "DONE",
  "description": "Done processing"
}