OptinMonster

https://optinmonster.com/docs/
Admin
OptinMonster is a conversion optimization platform that enables website owners to create effective...
Tokens:131,689
Snippets:2,562
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Example: Display First Name with Default

Source: https://optinmonster.com/docs/how-to-use-smart-tags-in-optinmonster

This example shows how to display the visitor's first name, using 'VISITOR' as a default if the name is not available.

```text
{{form_first_name|VISITOR}}
```

--------------------------------

### Full HTML Block Implementation

Source: https://optinmonster.com/docs/how-to-track-conversion-events-in-an-iframe

A complete example combining the overlay, instructions, iFrame, and tracking script.

```html
<div style="position: relative;">
    <a href="#" class="om-iframe-overlay" onclick="om_iframe_convert(this); return false;" style="display: block; position: absolute; top: 0; left: 0; width: 100%; height: 100%; z-index: 10;"></a>
    <p>Double click to interact with the form.</p>
    <iframe src="https://example.com/form" width="100%" height="300"></iframe>
</div>

<script>
function om_iframe_convert(el) {
    window.om_conversion('YOUR_CAMPAIGN_SLUG');
    el.style.display = 'none';
}
</script>
```

--------------------------------

### Redirect URL with Smart Tag

Source: https://optinmonster.com/docs/passing-lead-data-to-redirect-urls-in-optinmonster

Example of appending the custom smart tag to a redirect URL.

```text
https://optinmonster.com/{{query_args}}
```

--------------------------------

### Example Redirect URL with Lead Data

Source: https://optinmonster.com/docs/passing-lead-data-to-redirect-urls-in-optinmonster

Shows the format of the URL when lead data is appended as query arguments.

```text
https://optinmonster.com/?om_email=name@email.com&om_name=John+Smith&om_phone=5555555555
```

--------------------------------

### Configure Wistia Video Parameters

Source: https://optinmonster.com/docs/embedding-a-video-in-compatible-themes

Use query parameters to control Wistia video start times and transition effects.

```text
?time=30
```

```text
?transition=slide
```

```text
//fast.wistia.net/embed/iframe/VIDEO_ID?time=30
```

```text
//fast.wistia.net/embed/iframe/VIDEO_ID?transition=slide
```

--------------------------------

### Add Optional Interaction Instructions

Source: https://optinmonster.com/docs/how-to-track-conversion-events-in-an-iframe

Provide text to guide users on how to interact with the embedded iFrame.

```html
<p>Double click to interact with the form.</p>
```

--------------------------------

### Example: Display Visitor's First Name

Source: https://optinmonster.com/docs/how-to-use-smart-tags-in-optinmonster

This Smart Tag displays the first name entered by the visitor in the form.

```text
{{form_first_name}}
```

--------------------------------

### om.Action.window

Source: https://optinmonster.com/docs/optinmonster-javascript-events-api

This event runs before a new window is opened, triggered by an action.

```APIDOC
## om.Action.window

### Description
Runs before a new window is opened based on an action.
```

--------------------------------

### Campaign Closing Events

Source: https://optinmonster.com/docs/optinmonster-javascript-events-api

Hooks that trigger during the campaign closing process, from the start of the close function to after cleanup.

```APIDOC
## om.Campaign.startClose

### Description
Runs at the start of the close function before we check for any conflicts with actually closing.

### Method
N/A (Event Hook)

### Endpoint
N/A

## om.Campaign.close

### Description
Runs at the end of the close function just before the close happens.

### Method
N/A (Event Hook)

### Endpoint
N/A

## om.Campaign.afterClose

### Description
Runs just after the close function.

### Method
N/A (Event Hook)

### Endpoint
N/A

## om.Campaign.cleanup

### Description
Runs before we set cookies, but after a close.

### Method
N/A (Event Hook)

### Endpoint
N/A

## om.Campaign.afterCleanup

### Description
Runs after we set cookies.

### Method
N/A (Event Hook)

### Endpoint
N/A
```

--------------------------------

### om.Action.redirect

Source: https://optinmonster.com/docs/optinmonster-javascript-events-api

This event runs before a redirect action occurs, allowing for pre-redirect logic.

```APIDOC
## om.Action.redirect

### Description
Runs before a redirect action happens.

### Example
Log a message in the browser's console when the page is about to redirect to the Success URL.
```

--------------------------------

### Implement Conversion Tracking Javascript

Source: https://optinmonster.com/docs/how-to-track-conversion-events-in-an-iframe

Use this script to trigger the OptinMonster conversion event when the overlay is clicked.

```javascript
<script>
function om_iframe_convert(el) {
    // Trigger the conversion
    window.om_conversion('YOUR_CAMPAIGN_SLUG');
    // Hide the overlay
    el.style.display = 'none';
}
</script>
```

--------------------------------

### Manually Verify Site URL

Source: https://optinmonster.com/docs/how-to-add-edit-or-delete-a-website-in-optinmonster

Append this query parameter to a page URL where the OptinMonster embed code is installed to manually trigger site verification. This is an alternative to using the Verify link in the campaign builder.

```url
https://mysite.com/about-me?om-verify-site=true
```

--------------------------------

### Compare Embed Script Loading Attributes

Source: https://optinmonster.com/docs/optinmonster-campaign-performance-technical-overview-and-defaults

Comparison between the default async embed code and the modified version using the defer attribute.

```html
<script async src="https://a.omappapi.com/app/js/api.min.js" data-campaign="example"></script>
```

```html
<script defer src="https://a.omappapi.com/app/js/api.min.js" data-campaign="example"></script>
```

--------------------------------

### Configure YouTube Video Parameters

Source: https://optinmonster.com/docs/embedding-a-video-in-compatible-themes

Use query parameters to control YouTube video playback behavior such as autoplay, controls, and muting.

```text
?autoplay=1
```

```text
?controls=0
```

```text
www.youtube.com/embed/VIDEO_ID/?autoplay=1
```

```text
www.youtube.com/embed/VIDEO_ID?autoplay=1&controls=0
```

```text
www.youtube.com/embed/VIDEO_ID/?autoplay=1&mute=1
```

--------------------------------

### Track Conversion with Class

Source: https://optinmonster.com/docs/how-to-add-html-to-optinmonster

Add the `om-trigger-conversion` class to an HTML element to notify OptinMonster that a conversion has occurred and to set cookies if configured.

```html
<button class="om-trigger-conversion">Click Me</button>
```

--------------------------------

### Verify License Key on Multisite

Source: https://optinmonster.com/docs/how-to-use-optinmonster-with-wordpress-multi-site

Add this constant to your wp-config.php file to automatically verify the license key across all sub-sites in a network.

```php
define('OM_API_KEY', 'YOUR_API_KEY_HERE');
```

--------------------------------

### Track Conversion Only with Class

Source: https://optinmonster.com/docs/how-to-add-html-to-optinmonster

Use the `om-trigger-alt-converion` class if you only want to track conversions without setting any cookies.

```html
<button class="om-trigger-alt-converion">Click Me</button>
```

--------------------------------

### Configure Vimeo Video Parameters

Source: https://optinmonster.com/docs/embedding-a-video-in-compatible-themes

Use query parameters to control Vimeo video playback behavior such as autoplay, looping, and quality settings.

```text
?autoplay=1&muted=1
```

```text
?loop=1
```

```text
?quality=1080p
```

```text
//player.vimeo.com/video/VIDEO_ID?autoplay=1&muted=1
```

```text
//player.vimeo.com/video/VIDEO_ID?autoplay=1&muted=1&loop=1&quality=1080p
```

--------------------------------

### Basic Smart Tag Format

Source: https://optinmonster.com/docs/how-to-use-smart-tags-in-optinmonster

Use this format for any Smart Tag. It requires a tag name enclosed in double curly braces.

```text
{{SMART_TAG_NAME}}
```

--------------------------------

### OptinMonster Shortcode with Display Rules

Source: https://optinmonster.com/docs/how-to-manually-add-an-after-post-or-inline-optin

To make an inline campaign follow display rules when using a shortcode, add the `followrules=true` parameter. This ensures the campaign respects your set display conditions.

```shortcode
[optin-monster slug="CAMPAIGN_ID" followrules=true]
```

--------------------------------

### om.Action.view

Source: https://optinmonster.com/docs/optinmonster-javascript-events-api

This event runs before a view change occurs, triggered by an action.

```APIDOC
## om.Action.view

### Description
Runs before a view change happens based on an action.
```

--------------------------------

### JavaScript Module Request Format

Source: https://optinmonster.com/docs/how-to-measure-the-impact-of-optinmonster-on-your-website

The standard URL structure for fetching OptinMonster JavaScript modules.

```text
`https://a.omappapi.com/app/js/{number}.{hash}.min.js`
```

```text
`https://a.omappapi.com/app/js/13.5335765312.min.js`
```

--------------------------------

### Trigger File Download on Optin Success

Source: https://optinmonster.com/docs/trigger-file-download-on-optin-success

The SaveToDisk function handles cross-browser download triggering, while the jQuery event listener executes it upon successful optin submission.

```javascript
// Function SaveToDisk forces file download instead of viewing in browser
function SaveToDisk(fileURL, fileName) {
    // for non-IE
    if (!window.ActiveXObject) {
        var save = document.createElement('a');
        save.href = fileURL;
        save.target = '_blank';
        save.download = fileName || 'unknown';

        var event = document.createEvent('Event');
        event.initEvent('click', true, true);
        save.dispatchEvent(event);
        (window.URL || window.webkitURL).revokeObjectURL(save.href);
    }

    // for IE
    else if (!!window.ActiveXObject && document.execCommand) {
        var _window = window.open(fileURL, '_blank');
        _window.document.close();
        _window.document.execCommand('SaveAs', true, fileName || fileURL);
        _window.close();
    }
}

jQuery(document).ready(function($) {
    // Specify the OptinMonster Event that will trigger our file download
    $(document).on('OptinMonsterOptinSuccess', function(event, data, object) {
        // Update with the URL of the file you want downloaded on opt-in submission
        SaveToDisk('http://www.example.com/download-file.pdf');
    });
});
```

--------------------------------

### Trigger File Download by Page URL

Source: https://optinmonster.com/docs/trigger-file-download-on-optin-success

Triggers different file downloads based on the URL where the optin was submitted, allowing a single optin to serve multiple files.

```javascript
// Function SaveToDisk forces file download instead of viewing in browser
function SaveToDisk(fileURL, fileName) {
    // for non-IE
    if (!window.ActiveXObject) {
        var save = document.createElement('a');
        save.href = fileURL;
        save.target = '_blank';
        save.download = fileName || 'unknown';

        var event = document.createEvent('Event');
        event.initEvent('click', true, true);
        save.dispatchEvent(event);
        (window.URL || window.webkitURL).revokeObjectURL(save.href);
    }
    // for IE
    else if (!!window.ActiveXObject && document.execCommand) {
        var _window = window.open(fileURL, '_blank');
        _window.document.close();
        _window.document.execCommand('SaveAs', true, fileName || fileURL);
        _window.close();
    }
}

jQuery(document).ready(function($) {
    // Specify the OptinMonster Event that will trigger our file download
    jQuery(document).on('OptinMonsterOptinSuccess', function(event, data, object) {
        // Define the opt-in which should follow these rules when submitted.
        // Remove this condition if you want all opt-ins on the site to follow the same rules.
        if (data.optin == 'your-optin-slug') {
            // Variables for convenient reuse
            var url1 = "example1.com";
            var url2 = "example2.com";
            var url3 = "example3.com";

            var myHref = window.location.href;

            // If opt-in is submitted at url1, trigger download of download-file1.pdf on Optin Success
            if (url1 == myHref) {
                // Update with the URL of the file you want downloaded on opt-in submission
                SaveToDisk('http://www.example.com/download-file-1.pdf');
            }
            // If opt-in is submitted at url2, trigger download of download-file2.pdf on Optin Success
            if (url2 == myHref) {
                // Update with the URL of the file you want downloaded on opt-in submission
                SaveToDisk('http://www.example.com/download-file-2.pdf');
            }
            // If opt-in is submitted at url3, trigger download of download-file3.pdf on Optin Success
            if (url3 == myHref) {
                // Update with the URL of the file you want downloaded on opt-in submission
                SaveToDisk('http://www.example.com/download-file-3.pdf');
            }
        }
    });
});
```
Tokens:
Raw