Docs
HR

Odaberite jezik

eurinvoice.com
Docs
HR

Odaberite jezik

Postavi URL webhooka ili rotiraj njegovu tajnu

  • U sandboxu

Jednostavnim riječima

Postavlja adresu koja prima statusne događaje ili rotira njezinu tajnu.
PUT
/webhook

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.

Autorizacija

apiKey
headerAuthorizationBearer <token>

Ključ pošaljite kao bearer token: Authorization: Bearer <your-api-key>. Poziv za stanje usluge jedini je poziv za koji nije potreban ključ.

Tijelo zahtjeva

application/json
  1. body
url?string
Uzorak^https://
Formaturi
active?boolean
rotate_secret?boolean
Zadanofalse
contact_email?|
Duljinalength <= 254

Tijelo odgovora

Spremljeno.

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

Koga obavijestiti kada isporuke ne uspijevaju.

last_delivery?|null
secret?string

Prisutno samo kada je tajna stvorena ili rotirana u ovom pozivu.

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"}

Dohvati postavke webhooka (operatera ili, s admin ključem klijenta, postavke tog klijenta) GET

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.

Pošalji potpisani testni događaj na URL webhooka POST

Tijelo sadrži event_id, type (uvijek test), occurred_at i message, potpisane kao statusni događaj. Ne prijavljuje nijedan račun. Od 0.16.0 svaki parametar upita vraća 400.