Page Builder Summit Limited Time Offer - 20% OFF! Use coupon PBS20 - View Details

OmnisendPRO

This knowledge base article relates to the WS Form Omnisend add-on. Included with the Agency edition or buy separately for other editions.

The Omnisend add-on lets you add new contacts using an action and create a form automatically a single click on the add form page.

Installation

The plugin is installed in the same way as installing the WS Form PRO plugin.

Once installed you will need to activate the license for the plugin. When you purchase the plugin, you will be given a license key. If you have lost your license key(s), click here.

To activate your license key:

  1. Click WS Form in the WordPress administration menu.
  2. Click Settings.
  3. Click the Omnisend tab at the top of the page.
  4. Enter your license key.
  5. Click the Activate button.

If your license key fails to activate, please ensure you are using the correct license key and not your WS Form PRO license key.

Connecting to Omnisend

In order to use the add-on, you need to connect it to Omnisend. Connecting is easy!

Obtain Your Omnisend API Key

To obtain your Omnisend API key:

  1. Login to your Omnisend account.
  2. Go to Store Settings.
  3. Click on API Keys.
  4. Click Create API Key.
  5. Copy the API key provided.

Enter Your API Key

  1. Click WS Form in the WordPress administration menu.
  2. Click Settings.
  3. Click the Omnisend tab at the top of the page.
  4. Enter your Omnisend API key.
  5. Click Save.

If you do not have a Omnisend account, you can create a new account here.

Creating a Form for Omnisend

Automatically

WS Form can create a form for any of your Omnisend lists in a single click. This process not only creates a form but also fully configures WS Form so that the form is ready to use immediately.

To create a Omnisend form in WS Form:

  1. Click WS Form in the WordPress administration menu.
  2. Click Add New.
  3. Select the Omnisend tab at the top of the page.
  4. Click the Contact template.
  5. Wait a few moments while the form is created.

That’s it! Your form will be created and is ready to add to your website.

If your list does not appear, click the refresh icon in the Omnisend tab.

Manually

It is also possible to use any form created in WS Form and add an action so that it is submitted to Omnisend when a user saves or submits their form.

To add the action:

  1. When editing your form, click the Actions icon at the top of the page. The Actions sidebar will open on the right-hand side of the page.
  2. Click the Add  icon to add a new action.
  3. Select Add to a Omnisend from the Action pulldown. A series of settings will appear.

As with all sidebars in WS Form, click to the Save button at the bottom to save your changes, or click Cancel to disregard your changes.

The action settings are as follows:

When Should This Action Run?

You can choose to run the action when the form is saved, submitted, or both.

Opt-In Field

Use this setting to select which of your fields to act as the opt-in field. We recommend adding a checkbox field with a single checkbox. It is always recommended that you have an unchecked opt-in checkbox on your forms to ensure you comply with GDPR requirements.

Status

Choose what status the contact should be added with. The available options are:

  • Subscribed
  • Unsubscribed
  • Non Subscribed

Send Welcome Email

If this setting is checked, Omnisend will send a welcome email only if welcome workflow is turned on.

Field Mapping

Field mapping tells WS Form which of your form fields relate to the corresponding fields in Omnisend. For example you would want to map your Email field to the Email field in Omnisend.

To map a field:

  1. Click the Add  icon at the bottom right of the field mapping section.
  2. In the left-hand column, select your form field.
  3. In the right-hand column, select the corresponding Omnisend field.
  4. Repeat this process for each field on your form.
  5. Click the Save button at the bottom of the sidebar to save your changes.

Custom Mapping

Custom mapping allows you to set a Omnisend field to any value you wish, including the use of WS Form variables. For example you might want to map a lead source hidden field to a custom field in Omnisend.

To add a custom mapping:

  1. Click the Add  icon at the bottom right of the field mapping section.
  2. In the left-hand column, enter a value or a WS Form variable.
  3. In the right-hand column, select the corresponding Omnisend field.
  4. Repeat this process for each field on your form.
  5. Click the Save button at the bottom of the sidebar to save your changes.

Custom Properties

In addition to the standard Omnisend fields you can also add custom properties to the contact. Custom properties are added as name value pairs.

To add a custom property:

  1. Click the Add  icon at the bottom right of the field mapping section.
  2. In the left-hand column, enter a name. Names should only contain latin characters, numbers, and underscores. WS Form variables can be used in this setting.
  3. In the right-hand column, enter a value or a WS Form variable.
  4. Repeat this process for each custom property you wish to add to the contact.
  5. Click the Save button at the bottom of the sidebar to save your changes.

Tags

Tags are labels you create to help organize your contacts. You can add any number of tags to a contact.

To add a tag to a contact:

  1. Click the Add  icon at the bottom right of the tags section.
  2. Enter the tag name.
  3. Repeat this process for each tag.
  4. Click the Save button at the bottom of the sidebar to save your changes.