MessageFlow
MessageFlowPricingBlogAPI docs
PL
PL
  • MessageFlow Dokumentacja
  • 🚀KONTO
    • Dashboard
    • Panel użytkownika
      • Rozliczenia
      • Powiadomienia
      • Lista operacji
      • Menadżer plików
      • RODO
      • Ustawienia
        • Bezpieczeństwo
        • Autoryzacja IP
        • Dwuetapowe uwierzytelnianie (2FA)
        • API
          • Dodawanie nowego klucza API
          • Nadawanie uprawnień kluczy API
          • Ograniczenie dostępów dla wybranych adresów IP
          • Zarządzanie kluczami API
        • Webhooki
    • Logowanie i zarządzanie kontem
      • Jak utworzyć konto?
      • Logowanie do platformy
      • Resetowanie hasła
      • Zmiana hasła w aplikacji
      • Dwuetapowe uwierzytelnianie (2FA)
      • Resetowanie ustawień 2FA
    • Zarządzanie użytkownikami i ich rolami
      • Dodawanie użytkownika
      • Nadawanie uprawnień
      • Aktywacja konta użytkownika
      • Edytowanie i usuwanie użytkownika
  • 💬KONTAKTY
    • Dodawanie kontaktów
      • Dodawanie kontaktów ręcznie
      • Importowanie list kontaktów (CSV, Excel)
      • Pola dodatkowe
    • Segmentacja odbiorców
    • Archiwizowanie grup
    • Usuwanie grup
  • ✨KANAŁY KOMUNIKACJI W PANELU
    • E-mail
      • Overview
      • Dashboard
      • Kampanie
        • Lista kampanii
        • Eksport kampanii z listy
        • Autoryzacja domeny i nadawców
          • Autoryzowanie domen u hostingodawców
            • Autoryzowanie domeny hostowanej w Nazwa.pl
            • Autoryzowanie domeny hostowanej w Home.pl
            • Autoryzowanie domeny hostowanej w cyber_Folks
            • Autoryzowanie domeny hostowanej w Zenbox
            • Autoryzowanie domeny hostowanej w OVHcloud
            • Autoryzowanie domeny hostowanej w GoDaddy
        • Tworzenie kampanii e-mail
          • Projektowanie wiadomości za pomocą edytora drag-and-drop
          • Specyfikacja kreacji e-mail
          • Personalizacja kreacji e-mail
          • Tworzenie i pobieranie szablonów wiadomości
      • Analityka, odbiorcy i raporty
        • Monitorowanie dostarczalności, otwarć, kliknięć
        • Przechowywanie raportów z kampanii mailowych
        • Archiwizacja adresów e-mail, usuwanie adresów odbijających twardo, wypisy
      • Wychodzące
        • Lista wychodzących
        • Eksport listy
      • Ustawienia
        • Dodawanie strony wypisu
    • SMS
      • Overview
      • Dashboard
      • Kampanie
        • Lista kampanii
        • Eksport kampanii z listy
        • Tworzenie kampanii SMS
      • Analityka, odbiorcy i raporty
        • Raportowanie i analiza wyników kampanii SMS
        • Przechowywanie danych z kampanii SMS
        • Archiwizacja odbiorców, usuwanie odbiorców ze statusem ERROR
      • Przychodzące
        • Lista przychodzących
        • Eksport listy
      • Wychodzące
        • Lista wychodzących
        • Eksport listy
      • Ustawienia
        • Linki z sufiksami
        • Strony wypisu
      • Ustawienia wspólne
        • Nagłówki SMS
      • Integracja z krótkimi kodami (short codes)
      • Billingowanie SMS
    • Mobile push
      • Overview
      • Dashboard
      • Kampanie
        • Lista kampanii
        • Eksport listy kampanii
        • Tworzenie kampanii push
      • Wychodzące
        • Lista wychodzących
        • Eksport listy
      • Analityka i raport
        • Raport z kampanii push
        • Przechowywanie danych z kampanii push
      • Ustawienia wspólne
        • Aplikacje
        • Dodawanie urządzeń testowych
      • Segmentacja
    • RCS
      • Typy wiadomości RCS
      • Czym jest Brand Bot?
      • Jak uruchomić RCS?
      • Wskazówki do utworzenia kampanii
      • Specyfikacja techniczna usługi RCS
  • 🖥️KANAŁY API
    • E-mail API
      • Dashboard
      • Raport e-maili
      • Raport tagów
      • Raport domen
      • Raport czarna lista
      • Raport biała lista
      • Ustawienia
    • Mobile push API
      • Overwiev
      • Dashboard
      • Wychodzące
        • Lista wychodzących
        • Eksport listy
  • SMS API
    • Overview
    • Dashboard
    • Przychodzące
      • Lista przychodzących
      • Eksport listy
    • Wychodzące
      • Lista wychodzących
      • Eksport listy
  • ⚙️CENTRUM POMOCY
    • Integracje
      • Integracja z Salesforce
      • Integracja z SalesManago
      • Integracja z Synerise
      • Integracja z IdoSell
    • Wymagania systemowe
    • Pomoc techniczna
    • Dokumentacja API
    • FAQ
  • CENTRUM BEZPIECZEŃSTWA
    • Certyfikaty ISO 27001, 27018, 22301
    • Wzory dokumentów
    • Wykaz procedur
Powered by GitBook
On this page
  • Kanały i zdarzenia
  • Konfiguracja
  • Przesyłanie danych
  1. KONTO
  2. Panel użytkownika
  3. Ustawienia

Webhooki

PreviousZarządzanie kluczami APINextLogowanie i zarządzanie kontem

Last updated 2 months ago

Webhooki pozwalają na automatyczne przesyłanie informacji o zdarzeniach do określonego adresu URL, co umożliwia skuteczne śledzenie komunikacji. Po otrzymaniu danych przez skrypt system powinien zwrócić stosowny komunikat. Aby dowiedzieć się więcej skontaktuj się z naszym Zespołem Sprzedaży -> .

Dostępność monitorowania poszczególnych zdarzeń zależy od wybranego przez Ciebie planu.

Kanały i zdarzenia

W panelu MessageFlow masz możliwość konfiguracji webhooków dla następujących kanałów i zdarzeń:

  • E-maile transakcyjne – raporty doręczeń

  • Kampanie e-mail – raporty wypisów

  • SMS-y transakcyjne – raporty doręczeń

  • SMS-y transakcyjne – kliknięcia w linki

  • Komunikacja 2-way – SMS-y przychodzące

  • Maile panelowe – raporty

Konfiguracja

  1. W zakładce Webhooki wybierz interesujące Cię zdarzenie:

  • E-maile transakcyjne - raporty doręczeń

  • Kampanie e-mail - raporty wypisu

  • SMS-y transakcyjne - raporty doręczeń

  • SMS-y transakcyjne - kliknięcia w linki

  • Komunikacja 2-way - SMS-y przychodzące

  • Pushe transakcyjne - raporty doręczeń

  • Pushe panelowe - raporty

  • Maile panelowe - raporty

  • SMS-y panelowe - raporty

  1. Następnie w wybranym zdarzeniu uzupełnij:

    1. W podziale na subkonta - opcja dostępna tylko w E-maile transakcyjne - raporty doręczeń, dzięki niej będziesz otrzymywać zdarzenia z podziałem na subkonta dla raportów doręczeń (pamiętaj, żeby stosować unikalne message_id, aby agregować wszystkie webhooki (z kolejnymi statusami)..

    2. URL - adres, na który mają być wysyłane dane (endpoint)

    3. Drugi URL - opcjonalnie, zapasowany adres, na który mają być wysyłane dane

    4. Reguła powiadomień:

      • Opcja 1: co 1 godzinę, co 6 godzin, co 24 godziny,

      • Opcja 2: co 30 minut, co 2 godziny, co 24 godziny.

    5. Tryb autentykacji

      • Brak - bez dodatkowej weryfikacji

      • Basic auth - wprowadź login i hasło, które będą służyć do autoryzacji. Dodaj te informacje do ustawień autoryzacji na swoim endpoint.

  2. Po przygotowaniu skryptu do odbioru danych skorzystaj z opcji Test, aby upewnić się, że poprawnie odbiera on dane.

Ustawienia webhooków zostaną zapisane dopiero, gdy przejdziesz test pomyślnie.

  1. Sprawdź, czy Twój endpoint zwraca odpowiedź HTTP/1.1 200 OK, co potwierdza, że dane zostały prawidłowo odebrane.

Opcja Generuj SecretKey pozwala wygenerować unikalny ciąg znaków, który zabezpiecza przesyłane dane i zwiększa bezpieczeństwo.

  1. Po poprawnej konfiguracji webhooka kliknij w przycisk Zapisz.

Przesyłanie danych

Dane możesz przesyłać na wskazany endpoint za pomocą żądania POST -> każde zdarzenie to obiekt i jego struktura różni się między sobą w zależności od typu danego zdarzenia.

Twój endpoint powinien:

  • Sprawdzić autoryzację zgodnie z ustawieniami w panelu,

  • Zapisać otrzymany obiekt (JSON payload),

  • Odpowiedzieć statusem HTTP 200 OK.

Więcej o opisach struktur znajdziesz w naszej .

🚀
sales@messageflow.com
dokumentacji API