Dohvati postavke webhooka (operatera ili, s admin ključem klijenta, postavke tog klijenta)
- U sandboxu
Jednostavnim riječima
Od 0.16.0 ključ operatera čita postavke jednog klijenta pomoću client. Admin ključ klijenta smije navesti samo
svojeg klijenta; svaki drugi vraća 404. Nepoznat ili ponovljen parametar, ili prazan client, vraća 400.
Postavljanje i testiranje webhooka ne prima nikakve parametre upita (400): oni ostaju uz ključ samog webhooka.
apiKeyAuthorizationBearer <token>Ključ pošaljite kao bearer token: Authorization: Bearer <your-api-key>. Poziv za stanje usluge jedini je poziv za koji nije potreban ključ.
client?stringIzbor klijenta koji čini operater. Drugi oblik vraća 400.
^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$Trenutne postavke. Tajna se nikad ne vraća. Kada ništa nije postavljeno, url je null, a active je false.
application/json- response
url*|^https://uriactive*booleansecret_rotated_at?|date-timecontact_email?|Koga obavijestiti kada isporuke ne uspijevaju.
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 }}Izradi i provjeri dokument bez slanja POST
Pokreće shemu, preliminarne provjere, serijalizator za kanal i svaki službeni sloj validacije, zatim vraća izvješće i dokumente koje je izradio, svaki s bajtovima u content_base64 kada je velik 2 MiB ili manje. Ništa se ne šalje i ništa se ne pohranjuje osim zapisa zahtjeva. Koristite ga pri mapiranju novog klijenta. Broj izvan ograničenja (vidi konvencije) vraća 422 prije nego se pokrene ijedna provjera.
Postavi URL webhooka ili rotiraj njegovu tajnu PUT
Ključ operatera postavlja webhook operatera, koji prima događaje svih klijenata; admin ključ klijenta postavlja webhook tog klijenta, koji prima samo njegove događaje. Prvi poziv treba url i stvara tajnu, koja se vraća jednom. Rotacija vraća novu tajnu jednom. Kroz 24 sata usluga potpisuje svaku isporuku i novom i starom tajnom, pa partner može prijeći bez gubitka događaja. Isporučuju se samo događaji zapisani nakon prvog poziva. URL mora biti https, a svaka adresa na koju se njegov host razrješava mora biti javna: loopback, privatne, link-local, carrier-grade NAT, multicast, rezervirane adrese i adrese metapodataka oblaka odbijaju se, ovdje i ponovno prije svake isporuke. Preusmjeravanja se ne slijede. Od 0.16.0 svaki parametar upita vraća 400, pa pogrešno napisan client nikad ne može promijeniti webhook samog operatera.