Skip to main content
Custom Events

Learn how to create and manage custom events and custom fields for your automation workflows

Paulius avatar
Written by Paulius
Updated over a week ago

You can use Custom events to trigger custom automation workflows through API. Every custom event can have a list of the custom fields for any additional information that could be used in the Automation workflow content.

In this article, we'll explore how to effectively use Custom Events to optimize your marketing strategies and leverage additional data.


Before you begin

When you integrate your store with Omnisend, we get a set of standard events, including Signup, Placed Order, Abandoned Cart, etc. events. If you wish to set up the workflow for a different type of event, a Custom Event should be created.

Custom Events can be added to your account after integrating Omnisend with the 3rd party application or created manually. Some examples of Custom Events created by 3rd party apps include:

  • AfterShip Info Received — triggering the workflow when the order is shipped. Custom fields include the tracking number and tracking URL.

  • Intercom Review Created — triggering the workflow when the contact leaves a comment for the support agent's assistance. Custom fields include the rating and review content.

  • growave-wishlist-back-in-stock — triggering the workflow when the product added to the client's wish list is back in stock. Custom fields include information about the product.

  • Junip - Review Created — triggering the workflow when a new order is placed in your store. Custom fields include information about the product and the link to the review submission page.

Setup Process

For the Custom event to start working, you will need to add the event to your Omnisend account and set it up on the 3rd party side.

Creating an Event in your Omnisend account

To start Custom Events setup from the account side, go to Store SettingsCustom events:

1. Navigate to Store Settings → Custom Events.

2. Click "Create event" to get started. You'll be redirected to the API documentation to complete the action. Here, you can create custom events but cannot add custom fields.

3. Copy the API Key from your Store Settings and add it to the Header field.

4. Follow the Body Params wizard and click "Try it."

5. Once created, you'll find the custom event added to the Custom Events tab.

Useful Information

To edit a custom event, delete the current event, and create a new one through the API documentation.

Disabling a custom event will stop it from functioning, and any automations with this event as a trigger will be discontinued.

Re-enabling a custom event does not automatically turn on the previously disabled sequence; you must re-enable the workflow manually.

We strongly advise seeking assistance from your developer if you haven't worked with APIs before to set up custom events.

While API docs can help you comprehend the API's functionalities, for implementing integrations, it is recommended to seek the assistance of a developer. By providing the developer with the API documentation, they can understand how to connect to the system effectively. In essence, API docs serve as a guide for developers to establish a connection between 3rd-party applications and Omnisend API.

Custom Field Details

When adding custom fields to your Custom Event, consider the following:

  1. Custom Field Name: This name is for your account's reference and can be adjusted later.

  2. Custom Field System Name: The system name used when passing data through the API, which cannot be adjusted later.

  3. Custom Field Type: Specifies how data should be interpreted. Choose from field types such as Integer, Float, Boolean, String, Email, URL, Date, and DateTime.

  4. Custom Field is Required: Choose whether this field is essential and should be passed through the API each time.

Custom Field Types

  • Integer - should be used to pass number values only.

  • Float - should be used for numbers with a floating point.

  • Boolean - should be used for true or false values.

  • String - should be used to pass any string of characters that should only be used as values and not for calculations.

  • Email - should be used to pass an additional email address. If you don't need a second email address, you don't need to use this field.

  • URL - should be used to pass links.

  • Date - should be used to pass date information.

  • DateTime - should be used to pass time information.

We'd like to encourage you to consult with your website developer or refer to the 3rd party integration to define the appropriate data format.

API setup

Once the account setup is complete, proceed with the API setup. Refer to the API documentation for instructions on creating your custom event.

If integrating Omnisend with a third-party platform, the custom event will be created automatically, or you can find instructions in the integration guide.

Custom Events in Automation

To create a custom event, go to the Automation tabclick Create workflow Custom Workflow

In the Automation workflow trigger, along with other Standard options, you can find the Custom Events you created.

Once you add the Custom event to the Automation trigger, all other settings (Trigger filter, Split block, Personalization menu, etc.) will be populated with the information this event carries.

You can also add this information to the content of the message (Email, SMS, Push Notification).

In the Email message, you may make your content even more interactive, for example, by adding the Tracking Link to the button.

Unsubscribing from Custom event

If you are using a custom event for the automation workflow triggering, in the footer content block, you will have an unsubscribe link for your customers. We encourage you to add this link to all messages, but if you send a transactional message with the information about the order the customer placed, this is not obligatory.

Note! Automation workflows based on custom events will send messages to unsubscribed contacts. If you don't want to send messages to unsubscribed, make sure to add an Audience filter to exclude unsubscribers (Segment is NOT unsubscribers). Also, add an exit condition 'Contact enters a segment - Unsubscribers'. So, if anybody unsubscribes while in this workflow will exit it immediately.

By utilizing additional data through custom fields, you can optimize your marketing efforts and deliver targeted messages to your audience.

For further assistance with custom events, don't hesitate to reach out to [email protected].

Did this answer your question?