Check Pipz Documentation for Customer Journey Automation configuration, technical questions and quick references.

Pipz Automation - Documentation

Introduction

What is Pipz?

Pipz is a customer engagement platform that allows you to manage your customer journey and help with the growth of your business. Acquire, engage, understand and retain customers using event tracking, behavioral tracking, landing pages, automations, in-app messages and much more, in a real-time tool that was designed to make your life easier! What makes Pipz so special is that you can track past events as a flow trigger, send in-app messages and have real-time reports, as well as, a database with all of your contacts details and events. Pipz was developed by eCentry, a company engaged in three continents, with global customers in more than 80 countries, and with ample experience in the field.

Main Benefits

  • Safe, reliable and easy to use;
  • Email and event tracking;
  • Customize anything using variables, constants and complex conditions;
  • Multiple flows available;
  • Past events as flux triggers;
  • Integration with your favorite platforms;
  • Tracking of both contacts and anonymous people in your app;

Anti-SPAM Policy

It's extremely important that you understand that we have a very rigid Anti-SPAM policy. Any customer that uses Pipz infrastructure for spamming will be immediately blocked, and the related account(s) will be disabled with no refund of previously purchased credits. To ensure that you won't get into any trouble, we recommend that you read our Pipz Anti-SPAM Policy and Pipz Terms of Use. If you still have doubts about what you can and can't do, please, don't hesitate to contact us!

Warning!

If you are inactive for 30 days or if the payment is delayed by 30 days, your account will be cancelled automatically and all the data will be removed.

If you know, or have any indication, that Pipz is being used to send SPAM, please Report Abuse here!

Create an account

So now you have an idea of how powerfull Pipz can be! Did you like what you've seen so far? Want to see the real magic happening? Sign up for Pipz!

As soon as you've created your account, check your email inbox and follow the instructions to start using the system. When you login for the first time, you will have a few tasks to perform, as you will see later on this document.

Hey, real quick, did you know that Pipz is just one of eCentry's many products!? If you are curious to find out more, please check out our awesome products here!

Welcome! This is your Dashboard

Got your account? That's great! When you login to the system, the first thing you’ll see is your dashboard with a summary of your events and plan.

On the upper part of your screen you have account information, such as, the period that you've paid for, the people that can still be tracked and the days that you have left until your next payment.

On the lower part of the screen, you have the summary of the systems’ activities. If you check the top area (just below your account information) you can select a period of time to analyze your results. You can either select a specific period, or pre-defined periods, such as: All, Yesterday, Today, Last Week, Last Month and Last Year. The Dashboard will present the following information:

  • New contacts: new contacts added to your system due to automations during a specified period;
  • Active contacts: contacts that are still active in automations during a specified period;
  • Automations: automations that are still running during a specified period;
  • Actions: total of automations that where triggered during a specified period;
  • Sent emails: total of emails sent during a specified period
  • Events: total of events generated during a specified period;

If you scroll down, you'll see the same information in a graph display, according to the time period that you've selected: Hours, Days or Months.

Dashboard

Lateral Menu Overview

If you want to check your account information, such as, users, profile, password or email, click on the orange circle above your avatar image. Here, you can also set the time zone, language and add new users that will be allowed to navigate Pipz for you.

Here you can check the summary of your automation results, such as: New Contacts, Active Contacts, Automations, Actions and Emails Sent. These results can be checked in certain time periods (Today, Yesterday, This Week, This Month, This Year and All). Basically, the Dashboard is where you can monitor your activities in real-time.

If you want to follow a particular data history within the system, you should keep an eye on this option. Single interactions and anonymous interactions are listed here.

This is where you add your contacts. Here you can check their data, such as: profile, Interaction with the automation flows, lists, devices, lifecycle, events within the system and location

Here you can see all of the companies that have employees that navigate in your system! You can also take notes and edit the company’s profile!.

This is where you can create an automation flow that will automatically act based on user's behavior. From the moment a trigger is started, you will track your user's actions and the system will send an email, add/remove the user on a list, and many other customizable options. This is the heart of the Pipz experience!

  • Settings

    Here you can set the app you want to use and choose which trigger will start the automation. How often, start and end dates, and which days of the week should this automation run? You want it, here you decide it!

  • Steps

    At this point you start to let your imagination work. You can create the flow that better attends your needs, personalizing it based on your users' behavior. Create as many steps as you want, with conditionals and different integrations, so you can maximize your points of contact.

  • Queue

    A user can be added to a queue from an automation. That means that he doesn't necessarily has to trigger the automation to start it. Once you add him to a queue, he will automatically start going through the flow like every other contact on it.

  • History

    Here you find a list of every past event from this automation, organized in a chronological order.

  • Events

    Here every past event is also presented in a chronological order but now they are grouped with other events from the same contact.

  • Priorities

    If you choose to allow your user to be in just one automation flow at a time, you can set a priority list that will lead him always to the automation that was prioritized by you.

Here you can choose steps that you want to compare and analyze the conversion rate between them. With these data and further analysis you can see where you succeeded the most, what changes to make on your process and even which steps to drop out. This is really important when it comes to using the system's feedback to adjusting your strategy.

The integrated messaging system is one of the most interesting features inside of Pipz. You can send personalized in-app messages to a specific contact, or contacts, that have met stipulated requirements. Choose between six pre-stablished types of messages: Notification, Header notification, Call to action, Subscribe, Message, Survey and there is still more to come. Personalize its size, position, content and it’s done. You’re ready to start proactively amazing your customers.

At this feature you can create rules in order to segment your users based on attributes. This gives you the possibility of communicating only with specific users, maximizing the personalization of the messages you send. You can combine different rules and choose if the contacts have to match all or any of them.

This is where you view important data that aid your decision making process, in order to improve your business strategies.

You need some configuration done? It's definitely here!

  • App

    Here you configure a tracking code to connect your App to Pipz. This way all the events from you app will be sent to us to be treated.

  • Domains

    The DNS configurations help improve deliverability, reduce SPAM and guarantee that Pipz will have permission to send emails on your behalf. This step is mandatory if you want to incorporate emails to you automation flows.

  • Imports

    Check out the history of lists/contacts importation.

  • Integrations

    Choose the integrations that you want to be connected to your platform through Pipz. They can be a part of the automation flow or, if possible, be the source to trigger one.

  • Lists

    Here you check out the lists that you already have successfully created on your platform and the contacts on it. Other options at this feature are to send an email or In app message to all contacts of the list, add it to an existing automation flow and importing new contacts (by CSV File or manually).

  • Templates

    Create templates and save them to use again later. This way, if you need to use them in more than one occasion, you don't need to create them all over again.

  • Supression rules

    You create a set of rules for supression. Any contact that fulfills all requirements of the rule will not receive any email.

  • Supression list

    Here you can add the contacts that you, for some reason, don't want receiving your emails anymore.

Upload your contacts list!

You can upload all of your contacts information directly to the system. To do so, you need a list. If you don't have one you can access the Lateral Menu Settings > Lists > +. If you already have a list, just select it and upload the information.

Once your list is created and/or selected, you can go to the tab Import Contacts. There are two ways that you can import information to a new list: with a CSV (Comma-Separated Values) file, or by copying and pasting the info directly to the list. As soon as your contacts have been uploaded, you will be able to use all of Pipz amazing features!

If you wish to upload a CSV file, you can download an example to perform a perfect importation! Once you uploaded your contacts, you will be able to use all Pipz amazing features with them!

Import Contacts

All lists that are imported to Pipz should have both your contact's name and email. This is one of many Anti-SPAM restrictions that you need to be aware of! Any customer that uses Pipz infrastructure for spamming will be immediately blocked, and the related account(s) will be disabled with no refund of previously purchased credits. To ensure that you won't get into any trouble, we recommend that you carefully read our Anti-SPAM Policy and Terms of use.

Integration Between Pipz and Your App!

Pipz can integrate with your app in several ways, but for this to happen, you need to insert a short code inside of your webpage. When this is done, start using the system for this information to be sent back to us for processing. Below are the basics of this operation:

  • There is a small javascript code that you should insert in every webpage you want Pipz to keep an eye on. This is called an App and every App has a specific API Key and API Secret to identify it.
  • People that visit your webpage can be tracked (past and future) as they interact with it, but they are anonymous. You can identify them with an Identify method. This can be done once and only when your user is active (for instance, in the login, signup and form submission).
  • Once your contact is identified you can send events so that Pipz can store them. This is done with the Track method. It is not mandatory that you identify your user, but if you don't, all events will be stored as an Anonymous user
  • If you wish to see how many users that you have online, or send messages to them, you will need to establish a connection between Pipz and your app. This can be done with the Connect method.

To create a new App you go to: Lateral Menu > Settings > App > +. Just give your App a name and you are done!

Once you have created the App you will see a new window with your App configuration. The first tab, Auth, has an API Key and an API Secret. This is how you can identify your App and authorize it through API integration. The second tab, Integration Code, has a small integration code written in Javascript. You should copy it and paste it on the HTML file from your webpage before the head tag is closed (</head>). This should be done in every webpage from which you want to generate events or messages. Got it!?

If you inserted the code in the right place, everything should work smoothly! Go to the webpage from which you've just installed the code and it will appear as OK! (Check the Integration Code tab that we were just in!)

This gives you a general idea of how you can use Pipz' functionalities. Just be aware that both identified and unidentified contacts are stored in the system, and your plan has a limited number of people (both identified and anonymous), so if you don't want to fill your system with anonymous contacts, make sure to identify them before you track events.

trackerCode

How To Identify Users?

Your site is already connected, but you still need to insert some tools on your aplication so Pipz can manage user's actions.

The track method allows you to record an action that the contact (identified or not) has made inside of your system. Not only that, but these tracked events can also be used as triggers to start automation flows! All events can be stored along with custom properties that can be sent along the track method. For instance, if you want to track the download of an ebook, you can send an event like the one below:


            analytics.identify("john.snow@thrones.com", {
              "traits":  {
                  "name": "John Snow",
                  "city_name": "Winterfell"
                },
              });

Once your user is identified all actions that he performs (past and future) will be associated with him through cookies. You should identify your user in key-moments, such as, a form submission, a system signup, a newsletter signup, etc. Identify properties are:

  • userId: You should insert the database id of this contact or an email. This field is mandatory for user identification;;
  • traits: Information about your contact that is relevant to you. It is mandatory to send both your contact's name and email.

On traits, you can also insert the following fields on our contact's database:


            Name: contact.name
            Email: contact.email
            Company: contact.company
            Avatar: contact.avatar
            Phone: contact.phone
            Mobile Phone: contact.mobile_phone
            Language: contact.language
            Birthday: contact.birthday
            Gender: contact.gender
            Twitter: contact.twitter
            Facebook: contact.facebook
            Linkedin: contact.linkedin
            Website: contact.website 
            

How To Track Events?

The track method allows you to record an action that the contact (identified or not) has made inside of your system. Not only that, but these tracked events can also be used as triggers to start automation flows! All events can be stored along with custom properties that can be sent along the track method. For instance, if you want to track the download of an ebook, you can send an event like the one below:


            analytics.track("e-book download", {
                "title": "ebook volume I",
                "author": "John Snow",
                "edition": "2016"

            })

The event e-book download can be used to monitor several different ebooks within your website, while the properties can specify which ebook was downloaded at the time. The e-book download event will start any flow that has this name as a trigger.

There are predefined events that you can send to us. If you send an event, such as new contact, it will instantly appear in the events list. If you send an event, such as, page_view it will be stored as Contact has viewed the page Signup. The predefined events are:

  • page_view
  • signup
  • form_post
  • register
  • signed_for_newsletter
  • signed_for_invitation

The example that we just gave, associates the event with the user specified in properties, but will not associate any action (past or future) with this user, because he is not identified.

  • trigger: the event name to trigger your flow. This field is mandatory;
  • properties: properties of the event that you want the flow to recognize. This field is optional;

If your user is already identified by the system, you don't have to do it again. You can do the identify method in one place and a track method in another one. However, if your user is not identified and you use the track method, you must give the contact details on your method. If you wish to identify your user and track his actions at the same time, you can use them together like this:


            analytics.identify(contact.email, contac, function() {
              analytics.track("signup",{
                  "properties":{
                    "name": "John Snow"
                  }
            });

These methods must be inserted in a function inside your javascript file. When this function is called, the methods are activated. Remember that if you send a track but the user is not identified before, the event and anonymous contact will be stored in te system (and will be counted on your plan!). Be sure to do this only if you want to.

So, here is an example of how your code should look like. The trigger will be activated when thefunction submit is called. Then, it will take the form information (name and email), send it through and identification trigger (analytics.identify) that will finally create the trigger (analytics.trigger). After all this is done, a new function gotoSuccessPage will be called and it is finished. Your flow should now be running everytime someone submits a form!


            $(".subscribe-form").on("submit", function(e) {
              var name = $("#name").val();
              var email = $("#email").val();
              var contact = {       "name": name,       "email": email     };
              analytics.identify(contact.email, contact, function() {
                 analytics.track("signup", {
                       "language": "en"
                       }, function() {
                           gotoSuccessPage();
                       })
                 });
            });

Here is a simple implementation of the track method...


            <button name="submit" onclick="analytics.track('signup');" /> 

And if you want to identify the user...


            <button name="submit" onclick="analytics.identify($("#email").val(), analytics.track('clicked on submit button'));" /> 

Done! Your website is being tracked, and you are storing events. When your user performs an action, the event and its properties will be stored in the system.

How To Enable In-App Messages?

Your system will run smoothly now, but there are still some other features that you can enable to improve it. If you wish to know how many contacts that you have online, or send In-App Messages, you have to connect your app to our system through an online connection. Here are a few things that you must know about this connection:

  • The connection must be inserted in webpages where you want to communicate with your contact;
  • It must NOT be inserted in open webpages. It must be used inside your system and only when your contact is already identified and online;
  • You must send your contact's email and it should already be identified in our system;
  • You should have your App API Key and API Secret to establish this communication;
  • This connection must be secure, so you must create a hash on your backend to establish the connection.

The secure mode is mandatory and to enable it on your Javascript you need to calculate a SHA256 HMAC hash on your backend. This hash is a unique identifier and guarantees that a user can't send/receive messages as another user of the system. You will also need your CONNECTOR API Key and API Secret to establish the connection along with the new hash. Check out what RFC2104 says about secure connections:

"Providing a way to check the integrity of information transmitted over or stored in an unreliable medium is a prime necessity in the world of open computing and communications. Mechanisms that provide such integrity check based on a secret key are usually called 'message authentication codes' (MAC). Typically, message authentication codes are used between two parties that share a secret key in order to validate information transmitted between these parties."

Below are some examples that you can use in your system to establish a secure connection. Once you add the Connector to your website, the window object on your Javascript is modified and should have a property called Pipz Settings. You have to configure this property with your Connector API key, your contact’s email (which should already be identified) and the hash created on the backend (or server side).


            window.pipzSettings = {
              key: "CONNECTOR_API_KEY",
              email: "CONTACT_EMAIL",
              hash: "SHA256_HMAC"
            };

Here is an example of how you can create the hash on PHP:


            <?php echo hash_hmac("sha256", $user->email, "CONNECTOR_API_SECRET"); ?>

If you are using Django and Jinja, you can insert a python code here so that you can generate a HMAC along with your Connector API secret. It can be done as an expression on Jinja. To use this code you must perform an import hmac and import hashlib, as demonstrated in the example below.


            import hmac
            import haslib
            hmac.new(CONNECTOR_API_SECRET, CONTACT_EMAIL, digestmod=hashlib.sha256).hexdigest()

Now with Ruby on Rails!


            <%= OpenSSL::HMAC.hexdigest("sha256", "CONNECTOR_API_SECRET", "CONTACT_EMAIL") %>

For more detailed information on how to generate a hash using HMAC SHA256, you can check out this post! If you still have doubts, Bruce and Eddie are always ready to help!

General Example

If you wish to have a web page where your user will be identified, tracked and connected, it should look something like this::


            <html>
            <head><script>CONNECTOR CODE>/script> >/head>
            <body>
            <form>
            <input type="text" name="email"/>
            <button onclick="analytics.identify(this.email);" value="Identify yourself!">>/button>
            </form>

            <a href="#click-here" onclick="analytics.track('clicked');">Click here to send an event!>/a>

            </body>
            <script>
            window.pipzSettings = {
              key: "{{ CONNECTOR_API_KEY }}",
              email: "{{ request.user.email }}",
              hash: "{{ hmac.new(CONNECTOR_API_SECRET, request.user.email, digestmod=hashlib.sha256).hexdigest() }}"
            };</script>
            </html>

Ok! I Want An Automation!

Shall we get to the fun part!? This is where you can automate your life! It is highly recommended that you have your Connector ready! This way, once you finish your automation, it will already be running! If you wish to send emails or use other platforms, such as Maildocker, Slack or Hubspot, you have to configure these integrations. Their configurations are available further along on this documentation, so, if you want, go there to check them out and then come back here to learn how to configure your automation.

To access your automations and/or create a new one, go to: Lateral Menu > Automations > +. Then, you will need to give your automation a name and a reference connector. All your available connectors will be listed. If you don't have any Connector, please check the Connectors section.

Automation1

Once you have created your automation, you will find yourself in the Settings tab. Look at what you can configure:

  • Connector: Define or change the connector that this automation is linked to;
  • Triggers on: This option will define which trigger will start the flow! If you didn't set any trigger, please go back to the section How To Set Triggers In My Website? .
  • Contact Run Only Once: This option will make sure that the user will go through this flow once, and only once. You can configure it to send, for example, an email to welcome the new user to your system. This email can trigger a flow to add the new user in a list. This should be done only once, at the moment that the user signs up, so there is no need for this user to go through this specific automation again.
  • Contact Run Simultaneously:This option enables the user to be part of a second flow, even if he is already taking part of one. A good use for this option is when you need to send an email with an invoice to your user. The flow will keep reminding the user to pay the bill. Then, if the user gets another invoice, for any reason, he will be part of the same flow once again, reminding him of both bills;
  • Start Date: The time that this automation flow will start running;
  • End Date: If, for some reason, the automation flow needs a date to stop running, this is where you can configure it. This field is not mandatory;
  • Execute Actions On The Following Days: This option defines the days that the actions can be executed. Maybe it's not the best idea to send an invoice in the middle of a Sunday morning, right?
  • Execute Actions Only Within a Certain Time Range: This option restricts the time in which actions will be performed. For example, if you realize that most emails are opened at 8 AM, it is not interesting for you to send it at 11 PM!

Next task (and tab!) is to create your automation steps.

Managing Steps

The first thing you’ll see here is an orange circle which represents the trigger of your automation flow. By passing the mouse over it, you can see a button with a gear icon. This is where you can change the configuration of your trigger. You may click on the + sign and drag it to another position where you want to define the next action! Pretty simples, right?

Flow start

Once you have your arrow, you will have a few options on how to continue your automation. The options displayed below are the system’s default options, but once you have configured your integrations, they will be available for you to insert them, in the same manner that you will insert one of the default options, ok?

Api Call

Add to list: the contact is automatically added to a list inside of Pipz system. Once you choose this action, a pop up will appear and you will be able to choose one of your current lists. If you don't have any lists, please create at least one before moving on!

Api Call

API call: makes an API call to any API that you define by specifying: the http method that you want, URL, payload (depending on the method), user, password, and an object name for future interactions;

Condition

Condition: filters the flow according to events, contact or saved results. You have a list of events, such as: has opened an email and has rejected an email. Based on these events you can set two conditions, true or false, leading the automation to two independent paths according to your contacts reaction. You can change the condition of the path (True or False) by clicking on the arrow that will leave this step. You can configure more than one action for each of the options. For example, if the client didn't open the email, you can add him to a list of not interested and remove him from the flow.

End flow

End flow: it ends the flow;

Jump to flow

Jump to flow: moves the user to another flow and ends the current one;

Remove from all flows

Remove from all flows: removes the contact from all flows in which he is included;

Remove from flow

Remove from flow: removes the contact from a specific flow which you should define. It's not necessarily the one that the user is on at the moment;

Remove from list

Remove from list: it removes the user from a list specified by you;

Send email

Send email: it sends an email with a template chosen by you to a contact that is part of the flow.

The arrows connecting two actions can be used to define the time that the flow needs to wait before triggering the next action in sequence. By not setting a time, the default mechanism will perform the next action "immediately" after the end of the previous condition. You can set a value and choose the period that you think is more appropriate to run the next action.

Select time

Select time

Select time

And if you want a certain action to trigger another couple of actions? Don't worry! You can easily do this on your automation! Just add more arrows from the desired action, and all actions that are derived from it, will run in parallel, considering the “delay” that you have defined for each of them.

Multiple Tasks

The arrows that leave from a condition option have the true or false option, along with the delay, to filter the condition itself. In the case bellow, if the email was opened, it goes to send email, otherwise, it goes to add to list.

True and false arrows

You can continue creating and modifying your flow however you desire! When you feel satisfied with it, just click on Save (on the upper right corner of the screen) to store the changes in the flow. If you want to discard the changes, simply click on Cancel and it will not save any changes that were made in the flow during this session.

Quick Example

Let's create a simple automation flow as an example, shall we?

The orange circle represents your trigger. The plus + sign is where you can click to continue your flow. Click on it and drag it to another position on your screen.

Marketing Automation Tutorial - Step 1

Marketing Automation Tutorial - Step 2

Once you release the mouse button, some default options will appear. The integrations available to use in your automation flow are also shown, but you should configure them before the automation. Let’s use Send Email.

Marketing Automation Tutorial - Step 3

In your new email you can use a template that you've previously created. Select a template and the email is configured. On the lower part of your automation process, the template name will appear, so you’ll know exactly which email you will send in the current step.

Marketing Automation Tutorial - Step 4

Marketing Automation Tutorial - Step 5

Click on the immediately button and change the delay time to 1 minute.

Marketing Automation Tutorial - Step 6

Click on the + sign on the Send Email box and drag another arrow. From the default options, choose Condition. Select it to condition the flow by an event and choose has opened an email.

Marketing Automation Tutorial - Step 7

Marketing Automation Tutorial - Step 8

Marketing Automation Tutorial - Step 9

From the Condition box, click on the + sign and drag a new arrow. Select Add to List option. Select the list that you wish to use.

Marketing Automation Tutorial - Step 10

Marketing Automation Tutorial - Step 11

When you create an arrow that leaves a Condition box, it has not only the delay option, but also a True and False. The first arrow that you drag is, by default, always true. Click on the True icon to change it to False.

Marketing Automation Tutorial - Step 12

Marketing Automation Tutorial - Step 13

Finally, you can finish your flow with several options and conditions. This is just a simple example, but it is enough to show you what Pipz is capable of!

Marketing Automation Tutorial - Step 14

Integration With Other Platforms

Pipz is a powerful tool by which you can make awesome automations and integrate flows with other platforms! Check out how you can integrate all of the platforms that are currently available:

Freshdesk

Freshdeskis a cloud-based customer support platform. To integrate it with Pipz is very simple! On your Freshdesk page, go to the user button, on the upper right corner of the screen, and click on it.

Freshdesk1

Then, select Profile Settings. Once you're inside, you will see an API Key on the left side of the screen.

Freshdesk2

Then on Pipz, go to: Lateral Menu > Settings > Integrations > FreshDesk. Insert a new name for this integration (Item 1), then insert your API key from your FreshDesk account (Item 3) and finally, add your Freshdesk subdomain (Item 4). Done! Your Integration is complete! You can now use Freshdesk as a part of your automation flow!

Freshdesk3

Hubspot

If you have an account in Hubspot, don't worry! The integration is even simpler with Pipz! On your Hubspot Dashboard, go to your user area and select Integrations.

Hubspot1

On the left side, select the option Get your Hubspot API Key.

Hubspot2

Click on View Key and then Copy to Clipboard.

Hubspot3 Hubspot4

On Pipz, go to: Lateral Menu > Settings > Integrations > + > Hubspot. Insert a name for this integration (Item 1) and paste your Hubspot API Key (Item 3). That's it!

Instapage

From Instapage you can define a trigger to start an automation flow! The connection between Pipz and Instapage happens through webhooks, which is an easy way to integrate two systems. The webhook will be connected to a form inside of your landing page and, once you click to submit the form, the webhook will send an event to Pipz and it will function as a trigger to start an automation.

On Pipz, go to: Lateral Menu > Settings > Integrations > + > Instapage. Give your integration a name (Item 1), define the name of the event, or trigger (Item 2). Copy the URL available on Item 4 and go to your Instapage landing page edition dashboard.

Instapage1

On your Instapage dashboard go to Add New and select to add a new Form:

Instapage2

A form is created and you can edit it according to your preference. When you are finished, click the Edit button:

Instapage3

On the upper panel, go to the Integrations tab.

Instapage4

Select Webhooks.

Instapage5

A small popup will appear with an input box for you to paste a URL. This is where you should paste the URL that you copied from Pipz integration system (Item 4). Click login to continue.

Instapage6

The next screen tells you that your webhook is configured and you can check your URL on the options.

Instapage7

You should now configure your webhook to send data to Pipz by POST + JSON

Instapage8

Configure how the form information will be sent to you and it's done. You should publish your landing page and create an automation that begins with a trigger named flow_instapage_trigger!

Instapage9

Mailchimp

You can also integrate Pipz with Mailchimp in a very simple way! Login to your Mailchimp account and on the upper right corner, click on your username.

Mailchimp1

Choose profile.

Mailchimp2

On your profile area, go to the tab Extras and select API keys.

Mailchimp3

If you don't yet have any API Keys, something like the figure below will appear on your screen (scroll down to find this area). Click on Create a Key to create a new API Key.

Mailchimp4

Once you've created a new API Key you need to copy it.

Mailchimp5

You should also find out where your Data Center is located to be able to perform your integration. The Data Center is the value shown in your Mailchimp URL just before .admin.mailchimp.com. In the example below, the Data Center is us13.

Mailchimp5a

On Pipz, go to: Lateral Menu > Settings > Integrations > “+” > Mailchimp. Provide a name for your integration (Item 1), paste the API key that you just copied from the Mailchimp dashboard (Item 3) and the Data Center (Item 4). Congrats! Now, your integration is ready!

Mailchimp6

Lander

Do you have a landing page in Lander and want to integrate it with Pipz? No problem! Go to your Lander dashboard and select the edit button on your desired landing page.

Lander1

Scroll down the edition page until you find the Integrate Your Landing Page area. Select the webhooks type of integration.

Lander2

On Pipz, go to: Lateral Menu > Settings > Integrations > + > Lander. Copy the URL given on Item 3 and insert it on the webhooks integration page on your Lander app. Click ok and you are done!

Lander4 Lander3

To actually activate the integration, you have to insert a form in your landing page. The activation of the automation will start once your form is submitted.

Lander5

Pipedrive

You can use Pipedrive in two ways: In (Blue) or Out (Black). You can either use pipz automation to create a new deal to be inserted in your Pipedrive account (out) or use events generated in your Pipedrive as an event to be stored in Pipz (in). Both integrations must be configured in your Pipedrive account icon > Settings

Pipedrive1

To activate in In option (Blue) you should select the Push Notification on the left size of the system.

Pipedrive4

Create a new notification.

Pipedrive5

On the new notification you must insert a URL. To get this URL you should go to Pipz > Lateral Menu > Settings > Integrations > “+” > Pipedrive (Blue) and get the URL on Item 3.

Pipedrive7

If you want a Pipedrive event to generate a trigger inside of Pipz, just insert *.* on the Events section, as shown in the figure below. But if you want Pipz to look for a specific Pipedrive event, specify it in this section.

Pipedrive6

However, if you want to activate in Out option (Blue) you should select API on the menu

Pipedrive2

Copy your Pipedrive API! You'll need this later on!

Pipedrive3

On Pipz, go to: Lateral Menu > Settings > Integrations > + > Pipedrive (Black) and paste it on Item 3.

Pushbullet

To integrate Pipz with Pushbullet, go to your Pushbullet account.

Pushbullet1

On your Profile tab (default initial tab) scroll down and click on Create Access Token .

Pushbullet2

Copy the token displayed on the black background area.

Pushbullet3

On Pipz go to Lateral Menu Settings> Integrations > + > Pushbullet and paste it on Item 3. Click Connect, and it is done!

RD Station

You can use Pipz to create new leads in your RD Station Account! To integrate both platforms, you should go to your RD Station account, on the left menu select Integrations.

RD1

On the Integrations tab, go to API and copy your Token.

RD2

On Pipz, go to: Lateral Menu > Settings > Integrations > + > RD Station and paste this token on Item 3. Click Save, and it is finished!

RD3

Unbounce

You can connect with your Unbounce page so that it can send events to your system. On Pipz, go to: Lateral Menu > Settings > Integrations > + > Unbounce copy the URL displayed on the Item 3.

unbounce1

Go to your Unbounce dashboard and select the page that you wish to connect with Pipz.

unbounce4

On that page, go to the menu on the right, on the area named Basic Form Integrations and click on Weebhook.

unbounce5

Paste the URL that you copied from Pipz and click Save and Continue.

unbounce6

You shouldreceive a new message stating that the connection was successful. That's it!

unbounce7

Didn't find your favorite app?

So, it is not enough! Didn't find your beloved app!? Contact Pipz, tell us which app you would like to see here and we will try our best to make it happen!

In-App Messages

An amazing feature of Pipz is In-App Messages. With this feature, you can send individual messages to contacts inside of your app. You can configure pretty much everything! To access this feature, go to: Lateral Menu > Auto Messages.

There are seven types of In-App Messages:

  • Notification: a simple message that the user can read and close it;
  • Message: a message that the user can read and enter a personal message;
  • Chat: a message that permits you to have an online chat with your client (future releases);
  • Survey: a message that the user can read and give a note;
  • Call to Action: a message inviting the user to go to another page. Must redirect him to a new url;
  • Subscribe: a message inviting the user to become part of a spetial list;
  • Custom: a personalized message (future releases);

There are nine pre-defined locations for you to display your In-App Message, as you can see on the image below. You can also define a custom position (to highlight a new feature in your app, for example) or even define a specific >div> to insert your message in your HTML file.

You can also define your message size:

  • Small: a message with 200 px size;
  • Medium: a message with 300 px size;
  • Large: a message with 400 px size;
  • Full Page: a message that occupies the entire page;
  • Custom: a message with personalized size.

Set Up Your Domain

Setting up the domain(s) is a very important task if you wish to send emails through our platform! You must set it up in order to start sending emails that were predefined on your automation flow, otherwise you won't be able to send emails outside the sandbox mode. To do so, after logging in to our system, on the lateral menu, go to: Settings > Domains. Look for the “+” sign at the top right corner of the page and click on it to add a new domain.

When you add a domain, you can see that there are a lot of gray fields. So, something must be missing, right?

domain invalid

Ok, we did everything that must be done inside of our platform, so now it's time to ensure that your domain authorizes Pipz to send emails in your behalf without it being considered SPAM!

To do this, you should ask your IT team to add two records in your Domain Name System (DNS): SPF and DKIM records. These configurations help improve deliverability, reduce SPAM and guarantee that Pipz will have permission to send emails on your behalf. All very nice, right?

Let's first check out the SPF record. SPF stands for Sender Policy Framework which is an authorization that allows us (our mail servers) to send emails on your behalf. It allows the domain holder to set a server that will be permitted to send email messages. From here on we will guide you (and your IT team) on how to publish this ".txt" entry with the SPF settings. If you need any additional help, contact us!

In cases where the SPF is not yet configured you should create the following rule and add it to a TXT Record:

"v=spf1 include:spf.pipz.io mx ~all"

Each part of the record is defined as follows:

  • v=spf1 sets the SPF version being used
  • include:spf.ecentry.io includes Pipz servers as authorized servers
  • mx allows the domain's MX detail to send email
  • -all indicates that if an email is received from a server that is not previously listed, it is marked as a soft fail, which allows the email to be scrutinized further.

In cases where the SenderID is already configured and you want to add the Pipz IPs:

"v=spf1 ip4:xxx.xxx.xxx include:spf.ecentry.io a mx ~all" 

Make sure to replace "xxx.xxx.xxx" with your own IP!

Ok, now to the final step!

The DKIM (Domain Keys Identified Mail) refers to an Anti-SPAM authentication system that increases the email's integrity. When delivered to its destination, an email contains a public key, while another key is stored in the DNS source server. We recommend that you request your IT team to publish a “.txt” entry under the name "ecentry._domainkey.yourdomain.com.br", with the following content (no line-breaks):

"v=DKIM1; k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDBLTlS2DySFDRCsAqkUsIjAI7RvuRS6q5aTMyrdp9LogFjO7yTQKw/vw+bKrhHu1NuVWciRNp32m6E/imM5waqWL7w9xh4O8ap0jwORILrJvl/4NLLWXR/LuzIzmZ61nChq0vDOjdzCmBR6mALwzES4Ss2gPwldmTbtmVN14+0aQIDAQAB"

If you return to Menu > Setting > Domains, you should see your domain and an option to re-validate it. If everything is working properly, you should see some green items and you're ready for the next job!

Creating Templates

Is your DNS all set to send emails!? Then let's create some templates! On Pipz, go to: Lateral Menu > Settings > Templates Template icon +. You’ll need to provide the following:

  • A template name - this name will be used to identify the template. You will select it when building an automation flow.
  • Email subject
  • Sender name - this is the name that your contact will see
  • Sender email - this must be connected to a proper host that is already configured!

Once you’ve filled out those fields, you'll see three tabs. On the first one, Settings, you can change the information that you just gave to the system. The other two tabs contain fields where you can write your email. You can write it in HTML or in simple “.txt”. It's up to you! But if, for some reason, you write a template in the HTML tab and another in the Text tab (why!?) you should know that the HTML tab will have priority, ok?

Preview

If you decided to use HTML and want to see how it will look like when sent, you can click the Preview button on the upper right corner. If you write your template as a simple text, then there is nothing to preview! It will be sent just as you have defined!

You can also insert tags to facilitate the search for this template, as shown below:

Template tag

You are now ready to go!!

Variables

Everything looks good so far, but what if you want to insert personal information that vary according to the recipient of the email? No problem! You can insert variables contained in double brackets, such as {{}}. You can either pick one of our predefined variables or you can create a variable of your own, but make sure that you insert it on your email (Please check the next section). Here is an example of a HTML template with both types of variables:


            <html>
            <body>
            Customization test<br>
            Name: {{contact.name}}<br>
            Email: {{contact.email}}<br>
            Favorite Color: {{color}}<br>
            </body>
            </html>

Variables such as {{contact.name}} are variables that are already stored in our databases. Variables such as {{color}} can be created by you at any time, as long as you make sure to insert that piece of information on your API configuration, ok?

We have some variables available by default. Check them out:


            Name: {{contact.name}}
            Email: {{contact.email}}
            Phone: {{contact.phone}}
            Birthday: {{contact.birthday}}
            Gender: {{contact.gender}}
            City: {{contact.city_name}}
            Country: {{contact.country_name}}

And you can filter them! For example, if you want to show only your contact's first name, you can do something like this:


            First Name: {{contact.name | fname}}
            Last Name: {{contact.name | lname}}

Now you are the master of templates!

Creating Segments

On Pipz you can create a series of rules to separate your contact into smaller segments that you can manage. For instance, you can select all contacts that are from a specific city and have a birthday in July! You can use all of your contacts information to filter them and create a segment of customers.

If you wish to create a new segment of your contacts, you can go to: Lateral Menu > Segments > + > Give your new segment a name. On the tab Conditions you will see on the left column an option to select contacts that match any of the rules that you set, or that match all of the rules. For instance, imagine that you set two rules: contacts that were born before 1980 and contacts that live in New York City. If you select contacts that match any of the rules, you will see contacts born before 1980 in a city like San Francisco! Or contacts born in New York City in 1990. However, if the contacts should match all of the rules, you’ll only get those born before 1980 that live in New York City. You get the idea!

On the right column, you will have a glimpse of the contacts that will match the rules that you have set.

Contacts and Lists

To access your contacts’ information, you should go to: Menu > Contacts Contact icon. To add a new contact manually, you can click on the + sign on the upper right corner. If you have installed the Connector with the connection option, you will be able to see which contacts are online at the moment. To see detailed information about each contact, just click on their name.

Once you click on a contact, you will see your contact's dashboard. Here you can see information, such as: when he was last seen, number of emails that you have sent to him (and how he responded to them), location and purchases.

On the contact's dashboard you will see their main information and other features. If you navigate through the tabs, you will see which events this contact generated, automations that he has triggered and lists that he is in. You can also send individual emails and in-app messages to this particular contact through this panel. To do so, click on the Messages Message icon tab.

To access lists’ information, go to: Lateral Menu > Settings > Lists. You can add a new list manually, just like adding a contact! Go to the upper right corner and click on the + sign.

Contact Dashboard

Once you created a list, you will have access to the list’s dashboard, where you can see the number of contacts, as well as, the contacts that were added and removed from the list.

Lists1

On the Contacts tab you will see which contacts are currently added on this list and you can manually add a new contact or a pre-existing one from antoher list in the system.

On the Messages tab you can send an in-app message or an email to all contacts on this list. This option is not attached to any automation! For instance, you have a list of contacts of a particular city or country and there will be a promotion or a holiday that you want to let them know about. This is a simple way to perform such a task!

Lists3

If you wish to import several contacts at the same time, you can go to the Import Contacts tab. There are two ways that you can add contacts: you can either upload a CSV (Comma-Separated Values) file or copy and paste the names and emails on the right window. Both your contact's email and name must be added for the system to consider that contact valid! Remember that if you use Pipz to send SPAM in any way, your account will be suspended and you will lose all of your data, ok? So, adding both name and email of your contacts is mandatory, because it is one of many Anti-SPAM policies that we have.

Lists2

Contacts Attributes

Every contact has a series of attributes that you can store and filter them by. Some of them, you need to let us know about, while others, we store automatically. For example, when you want to add a new contact by using the track method, or through an API, you need to send us the information, because we can't obtain it automatically:


            Name: contact.name
            Email: contact.email
            Company: contact.company
            Avatar: contact.avatar
            Phone: contact.phone
            Mobile Phone: contact.mobile_phone
            Birthday: contact.birthday
            Gender: contact.gender
            Twitter: contact.twitter
            Facebook: contact.facebook
            Linkedin: contact.linkedin
            Website: contact.website 
            

On the other hand, we do receive the following information automatically:


            Language: contact.language
            Device: contact.device
            Operational System Family: contact.os_family
            Operational System Version: contact.os_version
            City: contact.city_name
            Continent Code: contact.continent_code
            Country Code: contact.country_code
            Country Name: contact.country_name
            Latitude: contact.latitude
            Longitude: contact.longitude
            Postal Code: contact.postal_code
            Region Name: contact.region_name
            Timezone: contact.timezone 
            Emails sent: contact.emails_sent 
            Emails Received: contact.emails_received 
            

Check what's going on!

There are few ways by which you can see how things are going with your system:

Results: Dashboard

On the upper part of the Dahsboard panel you can see your account information, such as: period that you have paid for, number of contacts that you can still add, and the amount of days that you have left until your next payment.

On the lower part, you have a summary of the system’s activities. If you check the upper area (just below your account information) you can select a period of time to analyze results. You can either select a specific period or select pre-defined periods, such as: All, Yesterday, Today, Last Week, Last Month, and Last Year. The dashboard will present the following information:

  • New contacts: new contacts added to your system due to the automations during the selected period;
  • Active contacts: contacts that are still active in automations during the selected period;
  • Automations: automations that are still running during the selected period;
  • Actions: total of automations that where triggered during the selected period;
  • Sent emails: total of emails that were sent during the selected period;
  • Events: total events that were generated during the selected period;

If you scroll down, you'll see the same information in a graph, according to the time period that you have selected: Hours, Days or Months.

Dashboard

Results: Reports

To access the Reports, go to: Lateral Menu > Reports. There, you can access contacts’ statistics, such as, when they were added or removed from a list in a specific time period. You can either select a specific period, or select pre-defined periods, such as: All, Yesterday, Today, Last Week, Last Month, and Last Year. In the example bellow, you can see the behavior of every list during the entire time that the user has been using Pipz.

Reports Lists All

This is an example of a specific list:

Reports List

Results: Chain of Events

If you access the Activities menu on: Lateral Menu > Activities, you will see a sequence of events that our system collected of each user. On this tab, you will see all of the events for each user, with the latest events appearing at the top. If you wish to check all of the events generated by a specific contact, you can go to: Lateral Menu > Contacts > Username > Events and check how that specific user is interacting with the system.

Pipz works with the concept of chain of events. This means that every action that is derived from an initial action is linked together. For example, let's say that you send two emails to your user: a welcome email and a first-steps email. Both emails have a link to a tutorial that the user can access on your website. With the chain of events, you can check from which email he accessed the tutorial and what actions he performed while there. This way, you can track which email was more efficient and what are the results that it gave inside of your website. Awesome, right?

Events Ex

Users Account

If you click on the orange circle above your avatar, you will have access to a variety of options about your account, as well as, an option to logout of Pipz system.

Account icon

The first option is My Profile, where you can see and edit information about your account. Look at what you can do here:

  • Personal: In here you will be able to upload an image to use as your avatar, change your name and get your User API Key and API Secret. This User API Key can be used to access information on Pipz through an API request. Don't confuse your USER API Key and CONNECTOR API Key. The CONNECTOR API Key allows you to send contact identification, events, connect with your website, and send emails. Your USER API Key allows you to access your Pipz system and get information about your contacts.
  • Change Password: Change your system password;
  • Change Email: Change the email that is connected to your account;
  • Preferences: Here you can set your time zone and system language. There is also an Enable Transitions option that will activate a softer transition between system areas when activated.

The second option is My Subscription, where you can find financial details about your plan, such as, your credit card information and all of your invoices.

  • Subscription: general information about your current subscription, such as, your plan type and the usage period;
  • Credit Cards: status of all credit cards stored on Pipz;
  • Invoice: information regarding your invoices such as: Creation Date, Due Date, Total Due, and Paid Amount.

On the System Settings tab, you can authorize other users to have access to your Pipz account. BEWARE! This is not the place to add contacts, it is for you to add your fellow colleagues! Anyone who is in this area will have access to all of the information available on the system! On the upper right corner you’ll see a + sign, where you can click to add new users. Each user will have their own USER API Key and API Secret, to access the system.