Ecomail umożliwia wysyłanie informacji z Ecomail do dalszego wykorzystania. Można do tego użyć tzw. webhooków.

ℹ️ Do testowania webhooków zalecamy użyć strony https://requestbin.com/.

Webhook w automatyzacji oraz w kampanii

1. Webhook w automatyzacji

Webhooki są dostarczane na określony adres URL przy użyciu metody POST w formacie JSON z następującą zawartością:

{
  "account": "example_account",
  "pipeline": 12345,
  "action": "67890",
  "email": "[email protected]",
  "subscriber": {
    "id": 1000001,
    "name": "John",
    "surname": "Doe",
    "email": "[email protected]",
    "gender": "male",
    "vokativ": "John",
    "bounce_soft": 0,
    "bounce_soft_count": 0,
    "bounced_hard": 0,
    "bounce_message": null,
    "inserted_at": "2025-05-14 09:39:15",
    "rating": 5,
    "nameday": "07-25",
    "source": "example_source",
    "company": "",
    "street": "Example Street 123",
    "city": "Example City",
    "country": "XX",
    "zip": "12345",
    "phone": "+1234567890",
    "pretitle": null,
    "surtitle": null,
    "birthday": null,
    "notes": null,
    "vokativ_s": "Johnny",
    "optimized_delivery": null,
    "tags": [
      "tag1",
      "tag2"
    ],
    "last_open": "2025-07-01 13:21:23",
    "last_click": "2025-06-25 14:01:33",
    "last_pageview": null,
    "raynet_id": null,
    "last_delivery": null,
    "since_last_open": null,
    "since_last_click": null,
    "last_transaction_id": null,
    "last_transaction": null,
    "automations": null,
    "sends_since_open": null,
    "sends_since_click": null,
    "skips": null,
    "attributions": null,
    "active": 1
  },
  "subscribers": [
    {
      "id": 1000001,
      "name": "John",
      "surname": "Doe",
      "email": "[email protected]",
      "gender": "male",
      "vokativ": "John",
      "bounce_soft": 0,
      "bounce_soft_count": 0,
      "bounced_hard": 0,
      "bounce_message": null,
      "inserted_at": "2025-05-14 09:39:15",
      "rating": 5,
      "nameday": "07-25",
      "source": "example_source",
      "company": "",
      "street": "Example Street 123",
      "city": "Example City",
      "country": "XX",
      "zip": "12345",
      "phone": "+1234567890",
      "pretitle": null,
      "surtitle": null,
      "birthday": null,
      "notes": null,
      "vokativ_s": "Johnny",
      "optimized_delivery": null,
      "tags": [
        "tag1",
        "tag2"
      ],
      "last_open": "2025-07-01 13:21:23",
      "last_click": "2025-06-25 14:01:33",
      "last_pageview": null,
      "raynet_id": null,
      "last_delivery": null,
      "since_last_open": null,
      "since_last_click": null,
      "last_transaction_id": null,
      "last_transaction": null,
      "automations": null,
      "sends_since_open": null,
      "sends_since_click": null,
      "skips": null,
      "attributions": null,
      "active": 1
    }
  ]
}

Gdzie wartości:

account - ID konta w Ecomail
pipeline - ID automatyzacji
action - ID akcji
subscribers - pole z obiektami JSON użytkowników, o których chodzi w tym zdarzeniu

Przetworzanie webhooka jest zależne od używanego języka programowania.

W przypadku PHP może to wyglądać na przykład tak:

$json = json_decode(file_get_contents('php://input'));

Zastosowanie w automatyzacji

W automatyzacji możesz ustawić krok, który wyśle aktualizację danych do webhooka. Automatyzacja może wyglądać następująco:

Krok "Wyślij dane na webhook" będzie wyglądać następująco:

Przetwarzanie webhooka zależy następnie od języka, którego używasz. W przypadku PHP może to wyglądać na przykład tak:

$json = json_decode(file_get_contents('php://input'));

ℹ️ Aktualnie Ecomail nie sprawdza, czy webhook został przetworzony pomyślnie, czy nie, i pozostawia tę odpowiedzialność klientowi.

2. Aktywność w kampanii

Jeśli chcesz uzyskać informacje o poszczególnych zdarzeniach z wysłanej kampanii, takich jak dostarczenie, odbicie, kliknięcie itp. możesz to zrobić za pomocą webhooka.

Webhook jest wysyłany metodą POST w formie JSON na zdefiniowany adres url. Jeśli webhook nie zostanie odebrany w ciągu 10 sekund, nastąpi przekroczenie limitu czasu. Po ustawieniu adresu url dla webhooka, zostanie wysłany przykładowy webhook.

Zdarzenia są wysyłane z klasycznych kampanii, automatyzacji oraz e-maili transakcyjnych (w tym e-maila double opt-in).

Konfiguracja adresu url do wysyłania webhooków

Ustaw adres URL w sekcji Zarządzaj kontem > Dla deweloperów > Webhook

Zdarzenia, które są wysyłane to:

bounce
delivery
injection
spam_complaint
out_of_band
policy_rejection
delay
click
open
initial_open
amp_click
amp_open
amp_initial_open
generation_failure
generation_rejection
list_unsubscribe
link_unsubscribe *
relay_injection
relay_rejection
relay_delivery
relay_tempfail
relay_permfail
ab_test_completed
ab_test_cancelled
success
error

* Nie chodzi o wypisanie się za pomocą linku rezygnacji (unsubscribe) Ecomail, lecz o kliknięcie przycisku „wypisz się / unsubscribe” w kliencie poczty e-mail. Taki kontakt jest przypisywany do listy suppression (listy wykluczeń).

Wszystkie zdarzenia są dostępne tutaj.

❓

Masz pytanie? Napisz do nas na [email protected]