Webhooks

Karta Webhooks umožňuje nastavit speciální adresy, na které se budou zasílat informace o provedených akcích externí službě.

Dostupné možnosti

Zde je seznam dostupných možností se stručným vysvětlením.

Webhook po objednání

Určuje adresu URL, na kterou bude odeslán požadavek typu POST s informacemi o objednávce ve formátu JSON.

Tip

Při provádění integrace berte prosím v úvahu, že nenabízíme verzování datové struktury ve webhooku. A v důsledku toho - ve vrácených datech se mohou objevit nové proměnné. Spoléhání se na datovou strukturu 1:1 může v budoucnu vést k chybám. Nejbezpečnější variantou je načítat každou proměnnou z řetězce JSON zvlášť a nepředpokládat například, že objekt adresa nebude v budoucnu naplněn dalšími informacemi.

Příklad formátu dat zasílaných pomocí webhooku.

{
   "encoded_id":"123-456-789",
   "number":"123/03/2020",
   "total_price":"138.45",
   "total_copies": "3",
   "total_photos": "2",
   "buyer":{
      "email": "test@email.com",
      "phone": "+48 000 000 000",
      "comment": "Comment on order",
      "address":{
         "parcel_locker":null,
         "is_company": "0",
         "company_name":null,
         "company_nip":null,
         "name": "Jan Kowalski",
         "street": "9 Jasmine Street",
         "postcode": "12-345",
         "city": "Cracow",
         "country": "Poland"
      }
   },
   "delivery":{
      "id": "2",
      "name": "Personal collection (Online payment)",
      "price": "15.00"
   },
   "coupon":{
      "code":null,
      "price":null
   },
   "items":[
      {
         "size_id": "3",
         "size_folder":"13x18",
         "file_name":"Photo101.jpg",
         "copies": "1",
         "paper": "matte",
         "price": "23.25"
      },
      {
         "size_id": "1",
         "size_folder":"9x13",
         "file_name":"Photo022.jpg",
         "copies": "2",
         "paper": "glossy",
         "price": "50.10"
      }
   ]
}