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

{
  "email": "example@freshmail.com",
  "campaignHash": "ee4OvETddWcKNA==",
  "module": "campaign",
  "name": "open",
  "time": 1624352127,
  "version": 1
}

Typ click

1
2
3
4
5
6
7
8
9

{
  "url": "https://freshmail.com",
  "email": "example@freshmail.com",
  "campaignHash": "FTnnkQAR8T/UqA==",
  "module": "campaign",
  "name": "click",
  "time": 1624352225,
  "version": 1
}

Typ unsubscribe

1
2
3
4
5
6
7
8
9

{
  "listHash": "kJjEtpbF4n0+wQ==",
  "email": "example@freshmail.com",
  "campaignHash": "wrYzlsKXq3secg==",
  "module": "campaign",
  "name": "unsubscribe",
  "time": 1624352257,
  "version": 1
}

Co oznaczają poszczególne pola w strukturze webhook

email - adres email odbiorcy mail

campaignHash - hash kampanii której dotyczy 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
• unsubscribe - wypisanie z listy subskrybentów

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

listHash - hash listy z której odbiorca się wypisał (ta informacja jest tylko w unsubscribe)

time - czas zdarzenia

version - określa wersję webhook