Appearance
Webhooki
Mechanizm Webhook’ów pozwala przesyłać określone zdarzenia, na podany adres URL, w chwili ich zajścia. Dzięki czemu nie trzeba odpytywać interfejsu API. Moduł Webhook pozwala zatem na utworzenie komunikacji pomiędzy aplikacjami. Możesz dodać tyle URL na ile pozwala Twój pakiet, jeśli wykorzystasz dostępne adresy otrzymasz komunikat.
Lista obsługiwanych zdarzeń:
- Otwarcia
- Kliknięcia
- Zwroty
- Wypisy
- Zgłoszenia FBL
- Dostarczenia (Wymagana dodatkowa konfiguracja konta)
- SMS Dostarczenia
- SMS Kliknięcia
- Blacklist Dodania
- Blacklist Usunięcia
Konfiguracja
- W systemie SARE przejdź do zakładki Zaawansowane > API > Webhooki
- Kliknij Dodaj URL.
- Wypełnij formularz.
- Kliknij zapisz.
Otwarcia
json
{
"event": "opened",
"id": "666059dbd81e4",
"uid": "1",
"recipient":"adres@email.com",
"domain": "\"Nadawca\" <adres@email.com>",
"ip": "192.168.0.1",
"geolocation": {
"countryName": "Burkina Faso",
"countryCode": "BF",
"zipCode": "",
"cityName": "Ouagadougou",
"regionName": ""
},
"user_agent": {
"ua_string": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko\/20100101 Firefox\/102.0",
"type": "Browser",
"type_code": "browser",
"ua": "Firefox 102.0",
"ua_family": "Firefox",
"ua_family_code": "firefox",
"ua_family_vendor": "Mozilla Foundation",
"ua_family_vendor_code": "mozilla_foundation",
"ua_engine": "Gecko",
"os_name": "Windows 10",
"os_code": "windows_10",
"os_family": "Windows",
"os_family_code": "windows",
"os_family_vendor": "Microsoft Corporation.",
"os_family_vendor_code": "microsoft_corporation",
"device_class": "Desktop",
"device_class_code": "desktop",
"device_marketname": "unknown",
"device_brand": "unknown",
"device_brand_code": "unknown",
"ua_class": "unknown",
"ua_class_code": "unknown"
},
"mailing_id": "150",
"mailing_name": "Test wiadomo\u015bci Email",
"campaign_id": "0",
"campaign_name": false,
"mailing_list": "1",
"timestamp": 1717590491,
"UUID": null,
"is_bot": false,
"prop_cust": {
"cust_prop": "Custom property",
"cust_prop2": "Custom property 2"
}
}
Kliknięcia
json
{
"event": "clicked",
"id": "666052fed110e",
"uid": "1",
"recipient":"adres@email.com",
"domain": "\"Nadawca\" <adres@email.com>",
"ip": "192.168.0.1",
"geolocation": {
"countryName": "Burkina Faso",
"countryCode": "BF",
"zipCode": "",
"cityName": "Ouagadougou",
"regionName": ""
},
"user_agent": {
"ua_string": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko\/20100101 Firefox\/102.0",
"type": "Browser",
"type_code": "browser",
"ua": "Firefox 102.0",
"ua_family": "Firefox",
"ua_family_code": "firefox",
"ua_family_vendor": "Mozilla Foundation",
"ua_family_vendor_code": "mozilla_foundation",
"ua_engine": "Gecko",
"os_name": "Windows 10",
"os_code": "windows_10",
"os_family": "Windows",
"os_family_code": "windows",
"os_family_vendor": "Microsoft Corporation.",
"os_family_vendor_code": "microsoft_corporation",
"device_class": "Desktop",
"device_class_code": "desktop",
"device_marketname": "unknown",
"device_brand": "unknown",
"device_brand_code": "unknown",
"ua_class": "unknown",
"ua_class_code": "unknown"
},
"mailing_id": 149,
"mailing_name": "Test wiadomo\u015bci Email",
"campaign_id": "0",
"campaign_name": false,
"tag": "",
"url": "%www_version%",
"url_real": null,
"mailing_list": "1",
"timestamp": 1717588734,
"UUID": null,
"is_bot": false,
"prop_cust": {
"cust_prop": "Custom property",
"cust_prop2": "Custom property 2"
}
}
Zwroty
json
{
"event": "bounced",
"id": "666031fa6794c",
"uid": "1",
"recipient":"adres@email.com",
"domain": "\"Nadawca\" <adres@email.com>",
"mailing_id": 148,
"mailing_name": "Test wiadomo\u015bci Email",
"mailing_list": "1",
"campaign_id": "0",
"campaign_name": false,
"timestamp": 1717580282,
"bounce_code": 511,
"UUID": null,
"prop_cust": {
"cust_prop": "Custom property",
"cust_prop2": "Custom property 2"
}
}
Wypisy
json
{
"event": "unsubscribed",
"id": "664bd4d242f52",
"uid": "1",
"recipient":"adres@email.com",
"domain": "\"Nadawca\" <adres@email.com>",
"ip": "192.168.0.1",
"geolocation": {
"countryName": "Burkina Faso",
"countryCode": "BF",
"zipCode": "",
"cityName": "Ouagadougou",
"regionName": ""
},
"user_agent": {
"ua_string": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko\/20100101 Firefox\/102.0",
"type": "Browser",
"type_code": "browser",
"ua": "Firefox 102.0",
"ua_family": "Firefox",
"ua_family_code": "firefox",
"ua_family_vendor": "Mozilla Foundation",
"ua_family_vendor_code": "mozilla_foundation",
"ua_engine": "Gecko",
"os_name": "Windows 10",
"os_code": "windows_10",
"os_family": "Windows",
"os_family_code": "windows",
"os_family_vendor": "Microsoft Corporation.",
"os_family_vendor_code": "microsoft_corporation",
"device_class": "Desktop",
"device_class_code": "desktop",
"device_marketname": "unknown",
"device_brand": "unknown",
"device_brand_code": "unknown",
"ua_class": "unknown",
"ua_class_code": "unknown"
},
"mailing_id": 148,
"mailing_name": "Test wiadomo\u015bci Email",
"mailing_list": "1",
"campaign_id": "0",
"campaign_name": false,
"timestamp": 1716245714,
"reason": "",
"UUID": null,
"prop_cust": {
"cust_prop": "Custom property",
"cust_prop2": "Custom property 2"
}
}
Zgłoszenia FBL
json
{
"event":"complained",
"id":"62972bbea9c31",
"uid": "1",
"recipient":"adres@email.com",
"domain": "\"Nadawca\" <adres@email.com>",
"mailing_id":52,
"mailing_name":"test",
"campaign_id":"0",
"campaign_name":false,
"mailing_list":"6",
"timestamp":1654074302,
"UUID":null,
"prop_cust": {
"cust_prop": "Custom property",
"cust_prop2": "Custom property 2"
}
}
Dostarczenia
json
{
"event": "delivered",
"id": "6660587037b32",
"mailing_id": "150",
"uid": "1",
"recipient":"adres@email.com",
"source_ip": "127.0.0.1",
"remote_hostname": "smtp.mx.pl",
"remote_ip": "192.168.0.1",
"remote_mail_id": "Bank",
"delivery_info": "250 2.0.0 Ok: queued as 1EF64BE44E25AB2C42FB",
"timestamp": 1717590123,
"UUID": null,
"mailing_name": "Test wiadomo\u015bci Email",
"campaign_id": "0",
"campaign_name": false,
"mailing_list": "1",
"domain": "\"Nadawca\" <adres@email.com>",
"prop_cust": {
"cust_prop": "Custom property",
"cust_prop2": "Custom property 2"
}
}
SMS Dostarczenia
json
{
"event": "sms_delivered",
"id": "6660587037b32",
"uid": "1",
"timestamp": 1717590124,
"sms_id": "f0b04236900a1588683522744447",
"recipient": "+48123456789",
"sending_id": 150,
"campaign_id": 0,
"campaign_name": false
}
SMS Kliknięcia
json
{
"event": "sms_clicked",
"id": "629ef119d698e",
"uid": "1",
"sms_id": "f0b04236900a1588683522744447",
"recipient": "+48123456789",
"ip": "127.0.0.1",
"geolocation": {
"countryName": "Burkina Faso",
"countryCode": "BF",
"zipCode": "",
"cityName": "Ouagadougou",
"regionName": ""
},
"user_agent": {
"ua_string": "Mozilla\/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko\/20100101 Firefox\/102.0",
"type": "Browser",
"type_code": "browser",
"ua": "Firefox 102.0",
"ua_family": "Firefox",
"ua_family_code": "firefox",
"ua_family_vendor": "Mozilla Foundation",
"ua_family_vendor_code": "mozilla_foundation",
"ua_engine": "Gecko",
"os_name": "Windows 10",
"os_code": "windows_10",
"os_family": "Windows",
"os_family_code": "windows",
"os_family_vendor": "Microsoft Corporation.",
"os_family_vendor_code": "microsoft_corporation",
"device_class": "Desktop",
"device_class_code": "desktop",
"device_marketname": "unknown",
"device_brand": "unknown",
"device_brand_code": "unknown",
"ua_class": "unknown",
"ua_class_code": "unknown"
},
"sending_id": 150,
"campaign_id": 0,
"campaign_name": false,
"sending_list": "20",
"tag": null,
"url": null,
"url_real": "https:\/\/link.com",
"timestamp": 1654583577
}
Blacklist Dodania
json
{
"event":"blacklist_add",
"id":"66d6a7bcce7e4",
"uid":"3100"
,"timestamp":1725343676,
"value":"email.com",
"who":"rest_api",
"type":"domain",
"UID":"1"
}
Blacklist Usunięcia
json
{
"event":"blacklist_remove",
"id":"66d6a7bcce7e4",
"uid":"3100"
,"timestamp":1725343676,
"value":"email@email.com",
"who":"rest_api",
"type":"email",
"UID":"1"
}