Jurnalul livrărilor webhook
- În sandbox
De la versiunea 0.28.0. Livrările unui webhook, începând cu cea mai recentă încercare (cele încercate niciodată la urmă), cu starea, erorile și orele fiecărei livrări, dar fără evenimentul în sine. O cheie de client cu domeniul de acces read citește webhook-ul propriu (numirea altui client primește 404); cheia operatorului citește webhook-ul operatorului sau pe cel al unui client, cu client; cheia de operator doar pentru citire citește la fel. Cel mult limit rânduri (implicit 100, cel mult 500), cu truncated când există mai multe.
apiKeyAuthorizationBearer <token>Trimiteți cheia ca token de tip bearer: Authorization: Bearer <your-api-key>. Starea serviciului este singurul apel care nu necesită cheie.
client?string^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$state?string"pending""delivered""dead"limit?integer1 <= value <= 500100Livrările.
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}Aflați setările webhook-ului (ale operatorului sau, cu cheia de administrator a unui client, ale clientului respectiv) GET
Începând cu 0.16.0, cheia operatorului citește setările unui client cu client. Cheia de administrator a unui client poate numi doar propriul client; orice alt client primește 404. Un parametru necunoscut sau repetat, ori client dat gol, primește 400. Stabilirea și testarea unui webhook nu primesc niciun parametru de interogare (400): rămân la cheia proprie a webhook-ului.
Stabiliți URL-ul webhook-ului sau schimbați secretul acestuia PUT
Cheia operatorului stabilește webhook-ul operatorului, care primește evenimentele tuturor clienților; cheia de administrator a unui client stabilește webhook-ul propriu al clientului, care primește doar evenimentele lui. Primul apel are nevoie de url și creează secretul, care este returnat o singură dată. Schimbarea returnează noul secret o singură dată. Timp de 24 de ore serviciul semnează fiecare livrare cu ambele secrete, cel nou și cel vechi, astfel încât partenerul să poată trece fără să piardă evenimente. Sunt livrate doar evenimentele scrise după primul apel. URL-ul trebuie să fie https, iar fiecare adresă la care se rezolvă gazda sa trebuie să fie publică: adresele loopback, private, link-local, carrier-grade NAT, multicast, rezervate și de metadate cloud sunt refuzate, aici și din nou înainte de fiecare livrare. Redirecționările nu sunt urmate. Începând cu 0.16.0, orice parametru de interogare primește 400, deci un client scris greșit nu poate schimba niciodată webhook-ul propriu al operatorului.