Dokumentace
Pro vývojáře (API)Pro

Webhooky

Notifikace událostí na tvoji URL, podepsané secretem.

Webhook ti pošle HTTP POST na zadanou URL, když nastane událost. Nastavíš ho v Nastavení → Aplikace / Integrace (tarif Pro).

Podporované události

  • INVOICE_CREATED — vznikl doklad: faktura, zálohová nebo konečná faktura či daňový doklad k přijaté platbě, i jako koncept. Chodí i u pravidelné faktury, faktury z nabídky a kopie dokladu; druh dokladu je v poli typDokladu. Doklady převedené importem z jiného programu tuto událost neposílají.
  • INVOICE_PAID — doklad je celý uhrazený, ať platbou, označením „zaplaceno“, odečtem záloh, nebo úpravou částky. Doklad, který vznikne rovnou uhrazený, pošle obě události. Daňový doklad k přijaté platbě tuto událost neposílá, platbu oznámila už zálohová faktura.
  • CREDIT_NOTE_CREATED — dobropis vystaven. Událost si u webhooku zapínáš zvlášť.

Tělo požadavku má tvar { "id", "event", "createdAt", "data" }. V data je u faktur vždy cislo, externiId a cisloObjednavky, takže událost spáruješ se záznamem ve svém systému. U dobropisu je navíc puvodniFaktura a puvodniExterniId.

Doručení a opakování

Když tvoje URL neodpoví kódem 2xx do 10 sekund, doručení zopakujeme s rostoucím odstupem, celkem nejvýš šestkrát během zhruba hodiny. Stejná událost může výjimečně dorazit víckrát, třeba když požadavek zpracuješ, ale odpověď se k nám nedostane. Pole id je pro všechny pokusy stejné: podle něj duplicitu poznáš a zpracuješ ji jen jednou.

Podpis

Při vytvoření webhooku dostaneš podpisový secret (whsec_…) — zobrazí se jen jednou. Příchozí požadavky jím ověříš, že přišly od nás.