Aflați setările webhook-ului (ale operatorului sau, cu cheia de administrator a unui client, ale clientului respectiv)
- În sandbox
În cuvinte simple
Î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.
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?stringClientul ales de operator. O altă formă primește 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Setările curente. Secretul nu este returnat niciodată. Fără nimic setat, url este null și active false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Cui să i se spună când livrările mor.
last_delivery?|nullcurl -X GET "https://example.com/webhook" \ -H "Authorization: Bearer <your-api-key>"{ "url": "http://example.com", "active": true, "secret_rotated_at": "2019-08-24T14:15:22Z", "contact_email": "string", "last_delivery": { "at": "2019-08-24T14:15:22Z", "http_status": 0 }}Construiți și verificați un document fără să îl trimiteți POST
Rulează schema, verificările preliminare, serializatorul canalului și fiecare strat oficial de validare, apoi returnează raportul și documentele generate, fiecare cu octeții în content_base64 când are cel mult 2 MiB. Nu se trimite nimic și nu se stochează nimic în afară de jurnalul cererii. Folosiți-l la maparea unui client nou. Un număr în afara limitelor (consultați convențiile) primește 422 inainte de orice verificare.
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.