Dziennik dostaw webhooka
- W sandboxie
Od wersji 0.28.0. Dostawy jednego webhooka, od najnowszej próby (bez prób na końcu), ze stanem, błędami i czasami każdej dostawy, bez samego zdarzenia. Klucz klienta z zakresem read czyta dostawy własnego webhooka (podanie innego klienta daje odpowiedź 404); klucz operatora czyta webhook operatora albo webhook jednego klienta z client; klucz operatora tylko do odczytu czyta tak samo. Najwyżej limit wierszy (domyślnie 100, najwyżej 500), z truncated, gdy jest ich więcej.
apiKeyAuthorizationBearer <token>Klucz należy wysyłać jako token typu bearer: Authorization: Bearer <your-api-key>. Wywołanie stanu usługi jest jedynym, które nie wymaga klucza.
client?string^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$state?string"pending""delivered""dead"limit?integer1 <= value <= 500100Dostawy.
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}Pobranie ustawień webhooka (operatora albo, z kluczem administratora klienta, tego klienta) GET
Od 0.16.0 klucz operatora odczytuje ustawienia jednego klienta po podaniu client. Klucz administratora klienta może podać tylko własnego klienta; każdy inny daje odpowiedź 404. Nieznany lub powtórzony parametr albo puste client daje odpowiedź 400. Ustawianie i testowanie webhooka nie przyjmują żadnych parametrów zapytania (400): pozostają przy kluczu samego webhooka.
Ustawienie adresu URL webhooka albo rotacja jego sekretu PUT
Klucz operatora ustawia webhook operatora, który dostaje zdarzenia wszystkich klientów; klucz administratora klienta ustawia webhook tego klienta, który dostaje tylko jego zdarzenia. Pierwsze wywołanie wymaga url i tworzy sekret, który jest zwracany raz. Rotacja zwraca nowy sekret raz. Przez 24 godziny usługa podpisuje każde dostarczenie zarówno nowym, jak i starym sekretem, aby partner mógł przełączyć się bez utraty zdarzeń. Dostarczane są tylko zdarzenia zapisane po pierwszym wywołaniu. Adres URL musi być https, a każdy adres, na który rozwiązuje się jego host, musi być publiczny: adresy pętli zwrotnej, prywatne, link-local, carrier-grade NAT, multicast, zarezerwowane i metadanych chmury są odrzucane, tu i ponownie przed każdym dostarczeniem. Przekierowania nie są wykonywane. Od 0.16.0 każdy parametr zapytania daje odpowiedź 400, więc błędnie napisane client nigdy nie zmieni własnego webhooka operatora.