ResourcesKnowledge Base

Integration

Setup your your integration options and API access for 3rd party systems.

API settings

This section shows you the main information required for all your API calls - Your Client ID, MD5 hash as well as the URL of the API interface.

nastaveni-api.jpg

Allowed IPs

Both our XML-RPC and JSON APIs accept connections only from allowed IPs. To permit access from a specific IP you have to add such IP (or network) to this list.

povolene-ip.jpg

Tracker URL

Each link in email sent via Mailkit is assigned a track url that allows us to tracks clicks on links by individual recipients. Here you can setup the subdomain part of this tracker url to match your brand name (only for agency account administrators).

tracker-url.PNG

Subscribe and Unsubscribe webhook URLs

Whenever a recipient signs up or signs out, Mailkit processes this activity and can immediatelly relay this information to your endpoint using a webhook. The information is passed to these URLs using a POST method with a JSON structured data about the registered activity. The URL entered is validated on save using a GET and POST call to verify availability of the endpoint entered. 
webhooks_cz.png

The subscribe webhook POSTs the following fields in JSON structure:

EMAIL - email address of the recipient
ID_EMAIL - ID of the email address
DATE - date and time of the subscription in format of RRRR-MM-DD HH:MM:SS
IP - IP address used during confirmation
IP_ORIG - IP address used during confirmation
ID_ML - ID of the mailing list
CHANNEL - channel used to confirm subscription
UA - device user-agent-string used to confirm subscription
DATE_REQUEST - date and time of request for subscription
UA_REQUEST - device user-agent-string used to request subscription
IP_REQUEST - IP address used to request subscription
IP_ORIG_REQUEST - IP address used to request subscription
URL_CODE - validation code used in the link to confirm
FIRST_NAME - first name
LAST_NAME - last name
FAX - fax
GENDER - gender
MOBILE - mobile phone
NICK_NAME - nickname
PHONE - phone
PREFIX - title
REPLY_TO - reply-to address
STATE - state
STREET - street
VOCATIVE - vocative
ZIP - ZIP code
CITY - city
COMPANY - company
COUNTRY - country

CUSTOM1 - custom field no.1
...
CUSTOM25 - custom field no.25

For unsubscribe or topic subscription changes the POST will pass following fields in JSON stucture:

EMAIL - email address
ID_EMAIL - ID of email address
DATE - date and time of unsubscribe in format of RRRR-MM-DD HH:MM:SS
IP - IP address of unsubscribe request (when available)
IP_ORIG - IP address of unsubscribe request (when available)
ID_ML - ID of mailing list from which the recipient unsubscribed
ID_SEND - ID of campaign delivery from which the recipient unsubscribed
ID_MESSAGE - ID of campaign from which the recipient unsubscribed
ID_TOPIC_ACTIVE - list of recipient's active topics (in case of topic changes)
ID_TOPIC_INACTIVE - list of recipient's inactive topics (in case of topic changes)
TIMEOUT - duration of the timeout (in days for temporary unsubscribe)
EXPIRE - date and time of timeout expiration
METHOD - method used for unsubscibe (link_in_mail,manual,spam_report,list-unsubscribe_mail,api_unsubscribe,list-unsubscribe_oneclick,timeout)
UNSUBSCRIBE_ANSWER - unsubscribe reason selected
UNSUBSCRIBE_NOTE - optional unsubscribe reason text provided

Please keep in mind that not all values must be present and therefor POST may contain empty values for some of the fields.

Allowed domains

For implementing Event API on your website to tracks visitors, send events, track conversions and run remarketing campaigns it's necessary to permit calls from hostnames where the event API scripts will be used and verify control of such hosts.

povolene-domeny.jpg