Każdy z webhooków ma swoją strukturę, zależną od jego typu. Po zasubskrybowaniu konkretnego webhook będziesz dostawał poniższe informacje na wskazany adres.

Typ open

1
2
3
4
5
6
7
8

{
  "module": "transactional_email",
  "name": "open",
  "messageId": "03.02.02.aaaaa.1245...",
  "ip": "127.0.0.1",
  "time": 1618996547,
  "version": 1
}

Typ click

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "module": "transactional_email",
  "name": "click",
  "messageId": "03.02.02.aaaaa.1245...",
  "ip": "127.0.0.1",
  "userAgent": "Mozilla/5.0 ...",
  "url": "https://www.freshmail.pl",
  "time": 1618996547,
  "version": 1
}

Typ bounce

1
2
3
4
5
6
7
8
9

{
  "module": "transactional_email",
  "name": "bounce",
  "messageId": "03.02.02.aaaaa.1245...",
  "type": "hard",
  "reason": "reason ...",   
  "time": 1618996547,
  "version": 1
}

Co oznaczają poszczególne pola w strukturze webhook

module - jakiego modułu dotyczy dany webhook

name- nazwa zdarzenia. Aktualnie są dostępne:

• open - otwarcie maila
• click - kliknięcie w link znajdujący się w wiadomości mail
• bounce - odbicie wiadomości

messageId - unikalny identyfikator określający jakiej wiadomości dotyczy informacja

id - IP odbiorcy maila (ta informacja znajduje się tylko w click i open)

userAgent klient pocztowy za pomocą jakiego została otwarta wiadomość mail (ta informacja znajduje się tylko w click i open)

url - adres URL w który odbiorca kliknął (ta informacja jest tylko w click)

time - czas zdarzenia

reason - odpowiedź serwera w przypadku odbicia wiadomości email (ta informacja znajduje się tylko w bounce)

type - określa typ odbicia wiadomości email - może przyjąć dwie wartości: hard, soft (ta informacja znajduje się tylko w bounce)

version - określa wersję webhook