Documentation

Trigger settings

Configure when and how your engagement campaigns fire, based on visitor behaviour, the page they are on, and conditions you define. Banners, chat messages and surveys share the full trigger settings dialog; tours get a reduced version of it.

When to trigger

Choose the event that starts a campaign watching for its conditions.

Session

Fires when a visitor begins a new session on your website.

Fires immediately when a new session begins.

A session begins when a visitor first arrives on your website. After 3 hours of inactivity, their next visit counts as a new session. This trigger is not offered for tours — a tour's trigger dialog starts at Page view.

Page view

Fires when a visitor navigates to a new page on your website.

Fires immediately when a visitor views a page that matches your conditions.

A page view happens every time a visitor navigates to a new page on your website.

Custom event

Fires on custom events you send from your application.

Matches events with the exact name you specify. This option respects the frequency setting below — if frequency is "Send once", the campaign fires only once even when the event arrives many times.

JavaScript
Yaplet.trackEvent('customEvent', { name: 'your-custom-event' });
You can combine several trigger types. For example, set a Page view trigger with "Send once" frequency to auto-show a tour on the first visit, and add a Custom event with "Always trigger" so visitors can re-open it from a button.

Page rules

Decide which pages a campaign may fire on. The rule is called Current page, and it matches the visitor's current URL with text operators:

  • Equals / Does not equal — exact URL match
  • Contains / Does not contain — substring match
  • Starts with / Does not start with — prefix match
  • Ends with / Does not end with — suffix match
  • Matches pattern — wildcard matching using * (e.g. /blog/* matches all blog pages, /*/edit matches any edit page)
  • Matches regex — full regular expression matching (case insensitive)

You can combine several conditions with AND (all must match) or OR (any must match), and nest groups for more complex rules. Tours do not show this section at all: the pages a tour may start on come from its own Start URLs field in the tour editor.

Time on page

Set a condition on how long the visitor has been on the current page.

Fires when the visitor has been on the current page longer than the time you set, in seconds or minutes.

Difference from Page view with delay:
  • Page view with delay: the timer starts from the first matching page view and continues even if the visitor navigates elsewhere
  • Time on page: the timer resets every time the visitor navigates to a new page. It only counts time spent on the current page.

Visitor rules

Narrow delivery by what you know about the visitor. The available attributes are:

  • Country — pick a country from the list (equals / does not equal)
  • Last seen — when they were last active
  • Email — the visitor's email address
  • Name — the visitor's name
  • External ID — your own user identifier, supplied through identify()
  • Visitor ID — Yaplet's own id for this visitor, used for targeting a single person
  • Plan — the plan value you sent us for this visitor
  • Value — the custom value field you sent us
  • Banned — is true / is false, so you can include or exclude banned visitors
  • Signed up — when the visitor first arrived
  • Session count — how many sessions they have had

Frequency

Control how often the same visitor can receive a campaign.

Each visitor receives it only one time, ever.