Záznam doručení webhooku
- V sandboxe
Od 0.28.0. Doručenia jedného webhooku, od najnovšieho pokusu (bez pokusu na konci), so stavom, zlyhaniami a časmi každého doručenia, nie so samotnou udalosťou. Kľúč klienta s rozsahom read číta doručenia vlastného webhooku (uvedenie iného klienta odpovie 404); kľúč operátora číta webhook operátora alebo webhook jedného klienta cez client; kľúč operátora len na čítanie číta to isté. Najviac limit riadkov (predvolene 100, najviac 500), s truncated, keď ich je viac.
apiKeyAuthorizationBearer <token>Kľúč posielajte ako token typu Bearer: Authorization: Bearer <your-api-key>. Stav služby je jediné volanie, ktoré nevyžaduje kľúč.
client?string^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$state?string"pending""delivered""dead"limit?integer1 <= value <= 500100Doručenia.
application/json- response
data*array<>truncated*booleancurl -X GET "https://example.com/webhook/deliveries" \ -H "Authorization: Bearer <your-api-key>"{ "data": [ { "invoice_id": "string", "sequence": 0, "event_id": "string", "state": "pending", "failures": 0, "first_failure_at": "2019-08-24T14:15:22Z", "last_attempt_at": "2019-08-24T14:15:22Z" } ], "truncated": true}Zistenie nastavení webhooku (vlastných nastavení operátora, alebo s administrátorským kľúčom klienta nastavení tohto klienta) GET
Od 0.16.0 kľúč operátora číta nastavenia jedného klienta cez client. Administrátorský kľúč klienta môže uviesť len vlastného klienta; každý iný odpovie 404. Neznámy alebo opakovaný parameter, alebo prázdny client, odpovie 400. Nastavenie a testovanie webhooku neberú žiadne parametre dotazu (400): zostávajú pri vlastnom kľúči webhooku.
Nastavenie URL webhooku alebo výmena jeho tajného kľúča PUT
Kľúč operátora nastavuje webhook operátora, ktorý dostáva udalosti všetkých klientov; administrátorský kľúč klienta nastavuje webhook tohto klienta, ktorý dostáva len jeho udalosti. Prvé volanie potrebuje url a vytvorí tajný kľúč, ktorý sa vráti raz. Výmena vráti nový tajný kľúč raz. Po 24 hodín služba podpisuje každé doručenie novým aj starým tajným kľúčom, aby mohol partner prepnúť bez straty udalostí. Doručujú sa len udalosti zapísané po prvom volaní. URL musí byť https a každá adresa, na ktorú sa jeho hostiteľ preloží, musí byť verejná: loopback, privátne adresy, link-local, carrier-grade NAT, multicast, rezervované a metadátové adresy cloudu sa odmietajú, tu aj znova pred každým doručením. Presmerovania sa nesledujú. Od 0.16.0 každý parameter dotazu odpovie 400, takže chybne napísaný client nikdy nemôže zmeniť webhook operátora.