Documentation for Salespanel Webhooks v1

Webhook API v1 is in active development. Currently, it allows you to receive data of lead and companies identified on your landing pages with their activity data.

Webhook endpoints are configurable from your account dashboard. If your account is a managed business account then our support team can configure endpoints for you. Using Salespanel webhooks you can power your sales and marketing applications. Assistance on custom integration is available, please talk to our support for more information.

Data
Data is available in both JSON and XML format.

Contact
Contact object consists of an acquisition detail object, person detail object, and a company detail object. Details for attributes for these objects are provided later in this documentation.

Activity
Activity object provides data for a different kind of activities. For example email open, page visit or any custom activity. Details for attributes are provided later in this documentation.

Webhook triggers.

Let's understand when webhooks will be triggered.

A contact object is created when a visitor visits your website, you receive a POST create call with the contact object.
A contact is identified from webform or newsletter or direct email, you receive an UPDATE call with updated contact object. This updated contact object will have enriched information about the person+company or just company if it's an anonymously visiting company.
When the visitor performs any activity you will receive a POST create call with the activity object.

Objects and attributes

Contact Object
Each object contains a contact_id field which is the unique identifier for the visitor. All the subsequent calls will contain this field so that you can map all the data with this field.

Properties
- contact_id (string): Unique identifier for the contact object.
- acquisition_details (object)
- person_details (object)
- company_details (object)

person_details will be present only if the email is identified for a particular visitor.

Acquisition details

Contains details like browser, location, etc. at the time when the contact was acquired for the first time.

Properties
- landing_ip_address (string): IP address
- source (string): Either the utm_source parameter or the referrer website.
- landing_location (object): Location details.
- city (string)
- region (string)
- country (string)
- continent (string)
- landing_user_agent (object): Details of the device used to access the website.
- device (string): Device used, e.g. PC, iPhone etc.
- device_os (string): OS on the device, e.g. Windows 10, Android, etc.
- browser (string): Browser used with version, e.g. Chrome 73.0.3683, Mobile Safari 4.0.4, etc.

Person details

Contains details of the identified person like name, email, etc.

Properties
- name (string): Full Name
- first_name (string): First Name
- last_name (string): Last Name
- email (string): Email address
- twitter (string): Twitter handle of the contact.
- age_range (string): Age range of the contact.
- gender (string): Gender of the contact.
- location (string): Location of the contact.
- title (string): Current or most recent job title.
- organization (string): Current or most recent place of work.
- linkedin (string): URL of the contact's LinkedIn profile.
- facebook (string): URL of the contact's Facebook profile.
- bio (string): Biography of the contact.
- website (string): URL of the contact's website.

Company details

Contains details of the identified company like name, website, etc.

Properties
- name (string): The name of the company.
- location (string): The location or address of the company.
- twitter (string): The URL to the twitter profile associated with the company.
- linkedin (string): The URL to the LinkedIn profile associated with the company.
- facebook (string): The URL to the Facebook page associated with the company.
- bio (string): The company's bio.
- website (string): URL to the company's website
- domain (string): Domain of the company's website
- founded (string): The year the company was founded.
- employees (number): The number of employees with the company.
- category (string): The category of the company.

Activity Object
Activities are of different types:
- links: Web page visits. Form submission on a web page.
- email: If you are using Salespanel for tracking your email, all the email open activities are under this type.

Based on the type of activity, the fields returned by Salespanel will vary.
Each object contains a contact_id field which is the unique identifier for the visitor this activity is associated with.

Properties
- contact_id (string): Unique identifier for the contact object.
- created_on (string): Timestamp in ISO format (contains Timezone too). e.g. 2019-05-09T11:27:35.543575+00:00.
- activity_type (string): Type of activity.
- subject (string): Subject of the email sent. (applicable only when activity_type is email )
- page_title (string): Title of the page visited. (applicable only when activity_type is links )
- link (string): Link to the page. (applicable only when activity_type is links )
- form (boolean): Whether a form was submitted on the page. (applicable only when activity_type is links )

Please refer to the sample JSON or XML files provided to create parsers at your end.

Data transfer strictly follows with the EU-U.S. Privacy Shield framework. HTTP endpoints are not allowed for webhook triggers.
Was this article helpful?
Cancel
Thank you!