Docs

Stabiliți URL-ul webhook-ului sau schimbați secretul acestuia

  • În sandbox

În cuvinte simple

Stabilește adresa care primește evenimentele de stare sau schimbă secretul acesteia.
PUT
/webhook

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.

Autorizare

apiKey
headerAuthorizationBearer <token>

Trimiteți cheia ca token de tip bearer: Authorization: Bearer <your-api-key>. Starea serviciului este singurul apel care nu necesită cheie.

Corpul cererii

application/json
  1. body
url?string
Model^https://
Formaturi
active?boolean
rotate_secret?boolean
Implicitfalse
contact_email?|
Lungimelength <= 254

Corpul răspunsului

Salvat.

application/json
  1. response
url*|
Model^https://
Formaturi
active*boolean
secret_rotated_at?|
Formatdate-time
contact_email?|

Cui să i se spună când livrările mor.

last_delivery?|null
secret?string

Prezent doar când un secret a fost creat sau schimbat în acest apel.

curl -X PUT "https://example.com/webhook" \  -H "Authorization: Bearer <your-api-key>" \  -H "Content-Type: application/json" \  -d '{}'
{  "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  },  "secret": "string"}