[Trigger Guide] Quick introduction into available triggers.
What is an Automation Trigger?
Automation triggers listen for WordPress hooks or filters and executes a rule when these events are fired.
When a trigger/hook fires we intercept the data that passes through it and we make it available to our Automation component.
In this article we will briefly define each available trigger and list which action hook/filter it is associated with. If we’ve additional documentation or tutorials built to explain this trigger filter, we’ll link to those as well.
This document is a work in progress. Please see support to help improve this document.
Available Triggers
On Lead Create or Update
Relevant Action Hook
inbound_store_lead_post
Action Hook Source
Inbound PRO Plugin
inbound-pro/core/shared/classes/class.lead-storage.php
Hook Description
This action hook fires after ever successful lead creation or update event. It will run everytime a lead passes through a connected frontend form, or everytime a lead is manually updated.
Automation Use Cases
It’s rare that this trigger will be chosen over the trigger ‘On Lead Creation’ event. One reason to use this would be to check a lead if a lead has viewed a certain page at a later date when it’s profile is updated, or it has submitted a new form. But even then, it may be better to use the trigger ‘On Tracked Page View Event’.
Available Documentation
Documentation that used to be based on this event has now been updated to use the ‘On Lead Creation’ trigger.
On Lead Creation
Relevant Action Hook
wpleads_new_lead_insert
Action Hook Source
Inbound PRO Plugin
inbound-pro/core/shared/classes/class.lead-storage.php
Hook Description
This hook fires only when a lead is created for the first time.
Automation Use Cases
This hook/trigger provides a great opportunity to initiate an email series, or add a lead to a list, or export data to a 3rd party location.
Available Documentation
On Lead Update
Relevant Action Hook
wpleads_existing_lead_update
Action Hook Source
Inbound PRO Plugin
inbound-pro/core/shared/classes/class.lead-storage.php
Hook Description
This hook fires when a lead is updated, but never during creation. If a lead submits a connected form for a second time, this hook will not fire.
Automation Use Cases
You can still use this hook to run email followup series. You can also check to see if the lead has been added to new lead lists, or contains new lead tags. You may never need to use this trigger.
Available Documentation
On Double Optin Confirmation
Relevant Action Hook
inbound_double_optin_confirm
Action Hook Source
Inbound PRO Plugin
inbound-pro/core/shared/classes/class.confirm-double-optin.php
Hook Description
This hook fires when a list subscriber confirms their double optin confirmation request.
Automation Use Cases
In the circumstance that you’ve double-optin enabled for your lead list, you will not want to start your automation email series on the lead creation event. Just because we’ve created the lead profile, does not mean the lead has given us permission to begin emailing them. In this case you will want to build your email series on top of this trigger rather than ‘On Lead Creation Event’
Available Documentation
- Enabling Double Optin on Lead Lists
- General Information: Double Optin
- An in depth tutorial needs to be created but this tutorial should still help:
- [Tutorial] Create a Followup Email
On Draft to Publish Event
Relevant Action Hook
draft_to_publish
Action Hook Source
WordPress Core
http://hookr.io/actions/draft_to_publish/
Hook Description
This hook fires when a post transitions from draft status to publish status.
Automation Use Cases
In the beginning this trigger was used to fire New Post notification emails to lead lists. But we’ve since developed a stronger way to perform new post notifications through the ‘On Email Trigger Event’ trigger. Still this trigger is available for your imaginative uses. Check the link in the ‘Available Documentation’ section to see how we can still use this trigger to execute automation emails.
Available Documentation
On WP New User Creation Event
Relevant Action Hook
user_register
Action Hook Source
WordPress Core
http://hookr.io/actions/user_register/
Hook Description
This hook fired during a user registration event.
Automation Use Cases
This trigger can be used in a handful of creative ways. We can use this trigger to create leads as new users are created. We can also use this trigger to start email series. We can even target email series to particular user roles. Say you manually add a new guest author, you then can start sending them your guest publishing program email series. We do this at Inbound Now.
Available Documentation
On Tracked Link Click
Relevant Action Hook
inbound_track_link
Action Hook Source
Inbound PRO Plugin
inbound-pro/core/shared/classes/class.inbound-api.php
Hook Description
This hook fires every time one of our tracked links are clicked.
Automation Use Cases
This trigger can be used to listen to tracked link clicks. Tracked links can be included in call to actions, emails
Available Documentation
Currently no automation tutorials available.
Other available documentation:
- Manually tracking links on posts & pages
- How to prevent links from autotracking inside CTAs and Emails.
On Email Trigger Event
Relevant Action Hook
inbound_trigger_email
Action Hook Source
Inbound PRO plugin
/inbound-pro/core/mailer/classes/class.token-engine.php
Hook Description
This trigger fires when a user clicks a button available inside their posts/pages area. It’s used to manually invoke an automated email send meant for notifiying readers of a new blog post or new page.
Automation Use Cases
Let readers know when new content is available on your site.
Available Documentation
On Tracked Page View Event
Relevant Action Hook
inbound-pro/events/page_view
Action Hook Source
Inbound PRO plugin
/inbound-pro/core/shared/classes/class.events.php
Hook Description
This hook is fired during a front-end page view event.
Automation Use Cases
You can use this trigger to listen for leads to view a specific page before initiated an email sequence, or performing a certain action.
Available Documentation