Wskazówki i odpowiedzi od zespołu BUY.BOX

Waldemar Sadowski
Autor Waldemar Sadowski

Webhook

Wyślij informacje o nowych transakcjach tam, gdzie ich potrzebujesz


Webhooki to mechanizm do komunikacji pomiędzy naszą usługą a zewnętrznymi systemami. Pozwala on przesłać dane o nowych transakcjach na tzw. callback URL bez konieczności każdorazowego odpytywania naszego API. Możesz to wykorzystać do integracji np. poprzez usługę Zapier lub Make.com.

Ustawianie webhooka

Aby ustawić webhooka przejdź do zakładki Ustawienia > Integracje, a następnie odszukaj kafelek Webooks i kliknij przycisk Konfiguruj.

W kolejnym kroku wybierz swoją stronę, dla które chcesz ustawić webhooka, a w polu Webhook URL podaj adres URL, na który mamy wysyłać dane, np. https://hooks.zapier.com/hooks/catch/757146/ben5shg/.

Po kliknięciu przycisku Zapisz na wskazany adres URL będziemy wysyłać informacje o wszystkich nowych transakcjach zarejestrowanych dla Twojej strony wraz z danymi sprzedanych produktów.

Przykład wysyłanych danych

{
  "transId": "tr0123",
  "clickedAt": "2022-09-08T14:29:58+2000",
  "createdAt": "2022-09-08T15:02:41+2000",
  "campaignId": 22,
  "campaignName": "Sklep",
  "spaceId": 11,
  "spaceName": "Blog",
  "amount": 70.46,
  "commission": 5.12,
  "abpar1": "custom-param-1",
  "abpar2": "custom-param-2",
  "abpar3": "custom-param-3",
  "products": [
    {
      "offerId": 175,
      "campaignOfferId": "16587",
      "name": "Potop",
      "ean": "9788377916186",
      "quantity": 1,
      "amount": 40,
      "commission": 3.04
    },
    {
      "offerId": null,
      "campaignOfferId": "63807",
      "name": null,
      "ean": mull,
      "quantity": 2,
      "amount": 15.23,
      "commission": "2.08
    }
  ]
}

Uwaga! Pola zawierające null dotyczą produktów, których nie udało nam się zidentyfikować.

Do czego możesz wykorzystać webhooka?

  1. Zapisywania danych w swojej bazie lub arkuszu Google.
  2. Wysyłania powiadomień o nowych transakcjach np. na Slacka.
  3. Wysyłania powiadomień na swoją skrzynkę mailową.
  4. Zapisywania eventów (konwersji) w Google Analytics.
Kategorie: