Here you will find the information needed to have Kartra send out calls to an external App/Website of your choice every time any of your leads perform an action inside your Kartra account.
Some general notes to consider:
1. Please note that APIs are for advanced users with custom programming only.
2. The API relies on your external platform as much as it does on ours, so the depth of help our Support Team will be able to provide is very limited.
The outbound API is intended to inform you of events happening in your Kartra account. The API will send out those outbound calls whenever a specific list of actions, pre-defined by you inside the Kartra account, are triggered.
Configuring your outbound API
To pre-define those actions, navigate to My Integrations -> My API -> Outbound API. All you need to do is to enter the URL(s) you want our API to ping, and the specific event(s) you want us to notify you about. You may configure multiple URLs, and multiple notification events per URL.
The data contained inside the API calls
There are a number of events our API can notify you about, such as…
When a lead gets tagged.
When a lead is granted access to a membership.
When a transaction is processed.
When a lead fills in an opt-in form.
Etc.
The specific information contained within each of those event is different on a case by case scenario. For example, transaction-related notifications contain relevant details about the transaction itself: product, transaction amount, customer details, etc. That being said, the info is always sent as a raw body POST JSON formatted object.
Here’s an example of a JSON object sent when a lead is subscribed to a list:
Finally, you have to make sure that, inside your end-point URL(s), you have a script that catches and interprets the data passed by our API outbound notifications. For that purpose, your end point URL(s) must be written in a programming language that can catch the HTTP raw post request.
Here is a small PHP sample on how to get the raw post:
<?php
$postdata = file_get_contents("php://input");
// The data comes as an JSON so you will need to decode it
$postdata_decoded = json_decode($postdata);
// Now that you have all the data, you may grab it and pass it to your custom scripts
// Example: $postdata_decoded->lead contains the details of the specific lead triggering the action
?>
Below is the data that is being pinged by our api system when a lead gets subscribed to a list.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
action
list_subscription
action_details
"list":{
"list_id":integer,
"list_name":string
}
list_id: A unique numeric identifier for the list.
Below is the data that is being pinged by our api system when a lead gets unsubscribed from a list.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
action
list_unsubscription
action_details
"list":{
"list_id":integer,
"list_name":string
}
list_id: A unique numeric identifier for the list.
Below is the data that is being pinged by our api system when a lead is assigned a tag.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead is unassigned a tag.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead filled in a kartra form.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
action
filled_form
action_details
"tag":{
"form_id":integer,
"form_name":string
}
form_id: A unique numeric identifier for the form.
Below is the data that is being pinged by our api system when a lead is subscribed to a sequence.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead is unsubscribed from a sequence.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead completes a sequence.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have ht following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead clicks on a tracking link.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead clicks on a page split test link.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead makes a purchase
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
lead_id: A unique numeric identifier for the lead id.
product_name: The product name.
product_id: A unique numeric identifier for the kartra product.
product_price_point: The product price point of the transaction.
transaction_quantity: The product quantity.
transaction_full_amount: The final paid amount on this specific transaction.
transaction_base_amount: The base price for the transaction (for trial this will be the base price of the initial transaction).
transaction_discount: If any discount coupon was applied, the amount in dollars deducted from the original price.
transaction_tax: The amount of sales tax or VAT.
transaction_shipping: The shipping cost
transaction_affiliate: The username of the affiliate (“N/A” if no affiliate).
transaction_jv: The username of the jv broker (“N/A” if no jv).
transaction_date: The date of the transaction (Y-m-d H:i:s).
transaction_type: sale
transaction_parent_id: 0
transaction_subscription_id: A unique identifier for the subscription id (PayPal transactions will return PayPal subscription id. If there is no recurring payments this will be 0).
transaction_internal_subscription_id: A unique numeric identifier for the subscription id(if there is no recurring payments this will be 0).
transaction_subscription_pay_number: 1
transaction_last_4_card_digits: The last 4 digits of the used card (‘N/A’ if PayPal)
original_id: In case of a payment subscription, the order ID of the first transaction within the subscription. In this case it will be the same as the transaction_id since it is a first payment.
lead_country: The buyer country.
lead_country_code_2: The lead two letter country code at the moment of purchase.
lead_country_code_3: The lead three letter country code at the moment of purchase.
lead_ip: The buyer ip.
lead_state: The buyer state.
lead_phone_country_code: The buyer phone country code.
lead_phone_number: The buyer phone number.
lead_address: The buyer address.
lead_city: The buyer city.
lead_zip: The buyer zip code.
vendor_tracking_id_1: Vendor’s tracking ID 1 if the sale was generated from a tracking link.
vendor_tracking_id_2: Vendor’s tracking ID 2 if the sale was generated from a tracking link.
vendor_tracking_link: Vendor’s tracking link name.
trial: 1 or 0, depending on whether it is activated or not.
trial_period: The trial period in days.
trial_amount: The trial amount.
rebill_circle: Days left for the next payment. Present only for recurring subscription payments.
installments: The number of installments for the subscription. Present only for recurring subscription payments with finite number of installments.
payments_left: Number of upcoming payments until the end of the subscription. 9999 if “cancelled by customer”. Present only for recurring subscription payments.
shipping_first_name: Buyer’s shipping first name.
shipping_last_name: Buyer’s shipping last name.
shipping_address: Buyer’s shipping address.
shipping_city: Buyer’s shipping city.
shipping_zip: Buyer’s shipping ZIP
shipping_country: Buyer’s shipping country
shipping_state: Buyer’s shipping state
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
payment_processor_type: The payment processor type: “PayPal”, “Braintree”, “Stripe”, “Authorize.net”
Below is the data that is being pinged by our api system when a transaction is refunded or partially refunded
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
lead_id: A unique numeric identifier for the lead id.
product_name: The product name.
product_id: A unique numeric identifier for the Kartra product.
product_price_point: The product price point of the transaction.
transaction_quantity: The product quantity.
transaction_full_amount: The final paid amount on this specific transaction.
transaction_base_amount: The base price for the transaction.
transaction_discount: If any discount coupon was applied, the amount in dollars deducted from the original price.
transaction_tax: The amount of sales tax or VAT.
transaction_shipping: The shipping cost
transaction_affiliate: The username of the affiliate (empty if no affiliate).
transaction_jv: The username of the jv broker (empty if no jv).
transaction_date: The date of the transaction (Y-m-d H:i:s).
transaction_type: refund or partial_refund
transaction_parent_id: The actual order ID of the original transaction that is being refunded or charged-back.
transaction_subscription_id: A unique identifier for the subscription id (PayPal transactions will return PayPal subscription id. If there is no recurring payments this will be 0).
transaction_internal_subscription_id: A unique numeric identifier for the subscription id(if there is no recurring payments this will be 0).
transaction_subscription_pay_number: The number of payment within this rebill sequence: 1st installment, 2nd installment, etc. In this case, it will always be the 1st installment.
transaction_last_4_card_digits: The last 4 digits of the used card (‘N/A’ if PayPal)
original_id: In case of a payment subscription, the order ID of the first transaction within the subscription.
lead_country: The buyer country.
lead_country_code_2: The buyer two letter country code.
lead_country_code_3: The buyer three letter country code.
lead_state: The buyer state.
lead_phone_country_code: The buyer phone country code.
lead_phone_number: The buyer phone number.
lead_address: The buyer address.
lead_city: The buyer city.
lead_zip: The buyer zip code.
lead_ip: The buyer ip.
vendor_tracking_id_1: Vendor’s tracking ID 1 if the sale was generated from a tracking link.
vendor_tracking_id_2: Vendor’s tracking ID 2 if the sale was generated from a tracking link.
vendor_tracking_link: Vendor’s tracking link name.
shipping_first_name: Buyer’s shipping first name.
shipping_last_name: Buyer’s shipping last name.
shipping_address: Buyer’s shipping address.
shipping_city: Buyer’s shipping city.
shipping_zip: Buyer’s shipping ZIP
shipping_country: Buyer’s shipping country
shipping_state: Buyer’s shipping state
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
payment_processor_type: The payment processor type: “PayPal”, “Braintree”, “Stripe”, “Authorize.net”
Below is the data that is being pinged by our api system when a subscription is cancelled.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
lead_id: A unique numeric identifier for the lead id.
product_name: The product name.
product_id: A unique numeric identifier for the kartra product.
product_price_point: The product price point of the transaction.
transaction_date: The date of the transaction (Y-m-d H:i:s).
transaction_type: cancellation
transaction_parent_id: 0
transaction_subscription_id: A unique identifier for the subscription id (PayPal transactions will return PayPal subscription id. If there is no recurring payments this will be 0).
transaction_internal_subscription_id: A unique numeric identifier for the subscription id(if there is no recurring payments this will be 0).
transaction_subscription_pay_number: 1
transaction_last_4_card_digits: The last 4 digits of the used card (‘N/A’ if PayPal)
original_id: In case of a payment subscription, the order ID of the first transaction within the subscription.
lead_country: The buyer country.
lead_country_code_2: The buyer two letter country code.
lead_country_code_3: The buyer three letter country code.
lead_ip: The buyer ip.
lead_state: The buyer state.
lead_phone_country_code: The buyer phone country code.
lead_phone_number: The buyer phone number.
lead_address: The buyer address.
lead_city: The buyer city.
lead_zip: The buyer zip code.
payment_processor_type: The payment processor type: “PayPal”, “Braintree”, “Stripe”, “Authorize.net”
Below is the data that is being pinged by our api system when a lead plays video.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead completes video.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead reaches a point score for the first time.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
action
reaches_score
action_details
"points":integer
points: the points score number the lead has reached
Below is the data that is being pinged by our api system when a lead is granted access to membership (kartra/external).
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead is revoked access to membership (kartra/external).
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when an affilate signs up for a product.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a JV signs up for a product.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a visits a kartra page.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead subscribes to a calendar.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead completes a calendar.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have ht following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array. In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Below is the data that is being pinged by our api system when a lead cancels a calendar.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have the following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
middle_name: The lead’s middle name.
last_name: The lead’s last name.
last_name2: The lead’s second last name.
email: The lead’s email address.
phone_country_code: The lead’s phone country code.
phone: The lead’s phone.
company: The lead’s company.
address: The lead’s address.
city: The lead’s city.
zip: The lead’s zip.
state: The lead’s state.
country: The lead’s country.
date_joined: The date when the lead joined kartra.
website: The lead’s website.
ip: The lead’s IP.
ip_country: The lead’s IP country.
facebook: The lead’s facebook URL.
twitter: The lead’s twitter URL.
linkedin: The lead’s linkedin URL.
sales_tax_id: The lead’s sales tax id.
lead_picture: The lead’s picture URL.
source: The lead’s creation source (‘single-optin’,’double-optin’,’helpdesk’,’affiliate-signup’,’checkout’,’import’,’api’,’manual’,’checkout-first’).
score: The lead’s score.
referring_id: The lead’s referring affiliate id.
blacklisted: If the lead is blacklisted or not (0/1).
source_id: The lead’s source assed id.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
lead_preferred_time_zone: The lead’s preferred time zone.
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array . In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]
Once you have set up in your Kartra account the destination URL where you want the receive our API’s outbound pings, you will need a script that catches and interprets the data contained in those pings. Make sure it’s written in a programming language that can catch the http raw post request.
Here is a small PHP sample on how to get the raw post:
<?php
$postdata = file_get_contents("php://input");
// the data comes as an json so you will need to decode it
$postdata_decoded = json_decode($postdata);
// after this you can use the info passed from kartra in your own scripts.
// Ex: $postdata_decoded->lead contains the lead details that triggered the action
?>
Below is the data passed by our Outbound API system when a lead completes a survey.
Parameters
Values
lead
{
"id": integer,
"first_name": string,
"middle_name": string,
"last_name": string,
"last_name2": string,
"email": string,
"phone_country_code": string,
"phone": string,
"company": string,
"address": string,
"city": string,
"zip": string,
"state": string,
"country": string,
"date_joined": string (YYYY-mm-dd hh:mm:ss),
"website": string,
"ip": string,
"ip_country": string,
"facebook": string,
"twitter": string,
"linkedin": string,
"google_plus": string,
"sales_tax_id": string,
"lead_picture": string,
"source": string,
"score": integer,
"referring_id": integer,
"blacklisted": integer,
"source_id": integer,
"gdpr_lead_status": integer,
"gdpr_lead_status_date": string,
"gdpr_lead_status_ip": string,
"gdpr_lead_communications": integer,
"lead_preferred_time_zone": string,
"custom_fields": [
{
"field_id":integer,
"field_identifier":string,
"field_type":string,
// In the case of input_field and text_area this will be string, else it will have ht following structure:
"field_value":[
{
"option_id":integer,
"option_value":string,
},
{
"option_id":integer,
"option_value":string,
}
]
}
]
}
id: A unique numeric identifier for the lead.
first_name: The lead’s first name.
last_name: The lead’s last name.
email: The lead’s email address.
gdpr_lead_status: The lead’s GDPR status, possible values:
0 – For GDPR status off – Your account has GDPR deactivated
1 – For GDPR status not subject – The lead’s IP is from a country not subject to GDPR
2 – For GDPR status accepted – The lead has accepted the GDPR terms
3 – For GDPR status not accepted – The lead hasn’t accepted the GDPR terms
4 – For GDPR status unknown – The lead’s location could not be determined
5 – For GDPR status pending
gdpr_lead_status_date: The date of the last GDPR status change
gdpr_lead_status_ip: The IP of the last GDPR status change
gdpr_lead_communications: 0 – if the user has agreed to be contacted, 1 – if not
custom fields:
field_id – the unique id reference (integer)
field_identifier – the unique identifier chosen when it was created (string)
field_type – the field type (string with the following values: input_field, text_area, drop_down, radio_button, checkbox)
field_value – the value saved for the particular lead. In the case of input_field and text_area this will be string, if not it will be an array . In the case of checkboxes the values can have multiple values:
[
{
"option_id":1, // the unique id reference (integer)
"option_value":"red", // option value (string)
},
{
"option_id":integer,
"option_value":string,
}
]