## Co webhook posílá

Webhook je adresa na vaší straně, na kterou BulkGate hlásí, co se se zprávami
stalo. Portál mu říká `Potvrzení o doručení`, ale posílá na něj dvě věci
najednou:

| Co dorazí | Jak to poznáte |
|:--|:--|
| Potvrzení o doručení | Záznam se stavem odeslané zprávy a jejím `smsID` |
| Příchozí SMS (odpověď) | Záznam se `status` `10`, odesílatelem v poli `from` a textem zprávy |

Není to tedy dvojí nastavení — jedna adresa obslouží doručenky i odpovědi.

Formát dat se řídí tím, jestli máte zapnuté hromadné zasílání:

| Režim | Jak data chodí | Popis formátu |
|:--|:--|:--|
| výchozí | Jeden požadavek na každou zprávu, metodou GET | [Potvrzení o doručení](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-potvrzeni-o-doruceni-a-prichozich-zpravach/) |
| `Zasílat doručenky hromadně` | Dávka záznamů, metodou POST s `application/json` | [Hromadné potvrzení o doručení](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-hromadne-potvrzeni-o-doruceni-a-prichozich-zpravach/) |

## Kde se webhook nastavuje

Místo se liší podle toho, jaké rozhraní používáte. Ve všech případech vedou první
dva kroky stejně — v menu portálu klikněte na `Moduly a API` a v části
`Moje API a Moduly` otevřete kartu své aplikace.

| Rozhraní | Kde v detailu aplikace |
|:--|:--|
| HTTP API | Karta `Nastavení`, část `Web hooky`, dlaždice `Potvrzení o doručení` |
| `Email > SMS` | Jen `Email pro doručenky` — doručenky chodí e-mailem, ne na URL |

## Jak webhook zapnu

Dlaždice ukazuje, jestli je něco nastavené. Dokud není, je tu
`Nemáte žádná nastavení.` a tlačítko `Konfigurovat`.

![Část Web hooky s dlaždicí Potvrzení o doručení](docs:api-webhooks/webhooks_cs)

Tlačítkem `Konfigurovat` (nebo `Upravit`, pokud už nastavení máte) se otevře okno
`Nastavení potvrzení o doručení`.

![Okno Nastavení potvrzení o doručení s polem URL pro doručenky](docs:api-webhooks/delivery-report_cs)

Do pole `URL pro doručenky` zadejte adresu začínající `http://` nebo `https://` —
jiný zápis portál nepřijme. K tomu jsou tři zaškrtávátka:

| Volba | Co udělá |
|:--|:--|
| `Vypnout kontrolu dostupnosti URL` | Portál před uložením neověří, že adresa odpovídá |
| `Zasílat pouze v případě chyby` | Doručenka dorazí jen u neúspěšné zprávy |
| `Zasílat doručenky hromadně` | Doručenky chodí po dávkách místo po jedné |

Nastavení uložíte tlačítkem `Uložit`.

> [!TIP]
> Hromadné zasílání se hodí při velkých objemech — místo jednoho požadavku na
> každou zprávu dorazí jeden požadavek s polem záznamů. Formát dávky popisuje
> [Hromadné potvrzení o doručení](https://www.bulkgate.com/cs/dokumentace/api-administrace-a-tokeny/api-hromadne-potvrzeni-o-doruceni-a-prichozich-zpravach/).

Jakmile webhook nastavíte, dlaždice vypíše tři řádky — `URL` s adresou a u obou
voleb `Zasílat pouze v případě chyby` a `Zasílat doručenky hromadně` ikonu podle
toho, jestli jsou zapnuté.

## Jak webhook zruším

Šipka vedle tlačítka `Upravit` rozbalí nabídku s volbou `Smazat`. Potvrzovací
okno `Smazat nastavení` upozorní, že o nastavení doručenek přijdete a přestanou
vám chodit.

> [!WARNING]
> Zrušením webhooku se zastaví i příchozí zprávy — odpovědi na vaše SMS se
> nemají kam doručit.