Webhooky

Webhook je oznámení, které Simbila pošle na vaši adresu vždy, když se v účtu něco stane – například když zákazník zaplatí fakturu. Používá se na propojení s vlastní aplikací.

V menu klikněte na Nastavení a v levém sloupci na Webhooky, nebo použijte odkaz Nastavení → Webhooky.

Vytvoření webhooku

Klikněte na Nový webhook a vyplňte:

• Název – jak si ho pojmenujete v seznamu.
• URL endpointu – povinné; adresa, na kterou se má oznámení poslat.
• Popis – k čemu webhook slouží.
• Tajný klíč – nepovinný řetězec, ze kterého se počítá podpis zprávy. Díky němu si příjemce ověří, že zpráva opravdu přišla ze Simbily.
• Hlavička podpisu – název hlavičky s podpisem, obvykle X-Simbila-Signature.
• Aktivní – vypnutý webhook se neodesílá.

Uložíte tlačítkem Vytvořit.

Zpráva se posílá s hlavičkami X-Simbila-Webhook-Timestamp a X-Simbila-Webhook-Signature; podpis se počítá jako HMAC_SHA256(timestamp + "." + tělo zprávy, tajný klíč).

Sledované události

Nový webhook zatím nic neposílá – musíte mu určit, co má hlídat. Klikněte v seznamu na jeho název a v sekci Sledované události vyberte událost v rozbalovacím seznamu a potvrďte tlačítkem Přidat událost. Křížek u řádku událost zase odebere.

Nabízené události (názvy jsou zatím anglicky) pokrývají zejména:

• vystavení, úpravu, odeslání a změnu typu faktury (inv.create, inv.update, inv.sent, inv.typechange),
• zaplacení faktury a odeslanou upomínku (inv.paid, inv.reminder),
• vznik, úpravu a smazání platby (payment.created, payment.updated, payment.deleted),
• vystavení pravidelné faktury (rinv.issue),
• úspěch a neúspěch automatického stržení z karty (inv.chrg.succ, inv.chrg.fail),
• změnu tarifu účtu (acc.tarif.change).

Protokol doručení

V detailu webhooku je tabulka Protokol doručení se sloupci Událost, Stav, Pokusy, Vytvořeno a Poslední chyba. Sem se podívejte, když u vás oznámení nedorazila – uvidíte, jestli se Simbila pokoušela odeslat a co jí vrátil váš server.

Úprava a smazání

Ikona tužky v seznamu otevře formulář k úpravě, ikona koše webhook po potvrzení smaže.

Opačný směr – tedy volání Simbily z vaší aplikace – zajišťují API klíče.