Přeskočit na hlavní obsah

Webhook objednávky

Nastavení a použití webhooku objednávky

Jan Sedloň avatar
Autor: Jan Sedloň
Aktualizováno tento týden

Toto je pilotní verze webhooku. Payload (data) se může kdykoliv a bez předchozího varování změnit.

Webhook objednávky je způsob, jak automaticky posílat informace o nových objednávkách z vašeho Flixy obchodu do jiné aplikace nebo systému.

Funguje to tak, že když zákazník vytvoří objednávku, platforma Flixy automaticky pošle data (tzv. payload) související s právě přijatou objednávkou (např. ID objednávky, jméno zákazníka, co si objednal atd.) na předem zadanou webovou adresu – a to vše v reálném čase. Tím se data dostanou rovnou tam, kde je potřebujete.

Webhook lze přidat do následujících produktů:

  • Prodej / stažení digitálního obsahu

  • Sběr mailů / přihlášek

  • Produkt na míru

  • Rezervace času ve tvém kalendáři

  • Předplatné / Členství

  • Online kurz

Jak nastavit webhook

Při vytváření nových nebo úpravě již vytvořených produktů můžete v záložce "Možnosti" najít kartu "Webhook". Do pole stačí zadat URL, kam se má webhook odesílat.

Zde je postup:

  1. Klikněte na tlačítko "Přidat produkt" nebo klikněte na existující produkt, u kterého chcete webhook přidat.

  2. V sekci "Možnosti" se úplně dole nachází sekce "Webhook", na kterou klikněte.

  3. Objeví se pole, které po vás chce zadat URL adresu. Tu získáte v aplikaci, službě nebo systému, do kterého chcete data objednávky posílat.

  4. Získanou URL adresu vložte do tohoto řádku (na fotce níže se jedná o URL adresu služby Zapier, u vás se samozřejmě může jednat úplně o jinou službu, aplikaci nebo systém).

Jaká data webhook obsahuje

Následující tabulka obsahuje všechny možné atributy, které payload může obsahovat. Payload lze chápat jako balíček dat, který obsahuje všechny informace týkající se jedné objednávky.


Některé atributy zpravidla nejsou součástí každého payloadu, ale jen takových, kterých se týkají (např. atribut meetingDate bude vyplněn pouze u zakoupení produktu "Rezervace času ve tvém kalendáři").

Hodnota ceny totalAmount, price a podobné se zobrazují v nejmenších jednotkách (centy, haléře). Tzn. objednávka za 200 Kč bude zobrazena jako hodnota 20000.

✱ jsou povinné údaje

Název

Typ

Popis

orderId ✱

string

Unikátní ID objednávky

totalAmount ✱

number

Celková cena objednávky

currencyCode ✱

string

Měna (např. "CZK", "EUR")

isFunnel ✱

boolean

Zda byla objednávka vytvořena přes funnel

invoiceLink

string

Odkaz na fakturu (pokud existuje)

billingReason

enum

Platba za předplatné (SUBSCRIPTION_CREATE | SUBSCRIPTION_CYCLE)

meetingDate

string

Datum schůzky (pro meeting produkty)

productData ✱

object

Informace o produktu

└─ id ✱

string

ID produktu

└─ title ✱

string

Název produktu

└─ type ✱

string

Typ produktu (viz níže)

└─ price ✱

number

Cena produktu

└─ currencyCode ✱

string

Měna produktu

└─ trialDays

number

Počet dní zkušební verze

└─ afterTrialPrice

number

Cena po zkušební verzi

usedUpSellBumps ✱

array

Použité up-sell/bump produkty

└─ id ✱

string

ID up-sell produktu

└─ name ✱

string

Název up-sell produktu

└─ price ✱

number

Cena up-sell produktu

└─ currencyCode ✱

string

Měna up-sell produktu

customerData ✱

object

Informace o zákazníkovi

└─ email ✱

string

Email zákazníka

└─ name ✱

string

Jméno zákazníka

└─ countryCode

string

Kód země (např. "CZ", "SK")

customFields ✱

array

Vlastní pole z formuláře

└─ question ✱

string

Otázka z formuláře

└─ answers ✱

string[]

Odpovědi zákazníka

usedDiscountCode

object

Použitý slevový kód (pokud existuje)

└─ name ✱

string

Název slevy

└─ code ✱

string

Kód slevy

└─ discountType ✱

string

Typ slevy (AMOUNT nebo PERCENTAGE)

└─ discountAmount ✱

number

Hodnota slevy

Typy produktů

Webhook podporuje následující typy produktů:

  • CUSTOM_PRODUCT - Vlastní produkt

  • LEAD_MAGNET - Lead magnet

  • DIGITAL_DOWNLOAD - Digitální stažení

  • MEETING - Schůzka/konzultace

  • RECURRING_MEMBERSHIP - Opakující se členství

  • DIGITAL_COURSE - Digitální kurz

Příklad Payload

json
{
"orderId": "ord_123456789",
"totalAmount": 2990,
"currencyCode": "CZK",
"isFunnel": true,
"invoiceLink": "https://example.com/invoice/123",
"productData": {
"id": "prod_987654321",
"title": "Online Kurz Marketing",
"type": "DIGITAL_COURSE",
"price": 2990,
"currencyCode": "CZK",
"trialDays": 7,
"afterTrialPrice": 3990
},
"usedUpSellBumps": [
{
"id": "bump_111",
"name": "Bonus materiály",
"price": 500,
"currencyCode": "CZK"
}
],
"customerData": {
"email": "[email protected]",
"name": "Jan Novák",
"countryCode": "CZ"
},
"customFields": [
{
"question": "Jaký je váš cíl?",
"answers": ["Zvýšit prodeje"]
}
],
"usedDiscountCode": {
"name": "Uvítací sleva",
"code": "WELCOME20",
"discountType": "PERCENTAGE",
"discountAmount": 20
}
}
Dostali jste odpověď na svou otázku?