Ometria is a customer data and marketing platform. It leverages AI-powered insights and cross-channel marketing to help you create personalized experiences for your customers throughout their product journey.
RudderStack supports Ometria as a destination to which you can seamlessly send your customer data.
Once you have confirmed that your source platform supports sending events to Ometria, follow these steps:
From your RudderStack dashboard, add the source. From the list of destinations, select Ometria.
Assign a name to the destination and click Next. You should then see the following screen:
Ometria
Connection Settings
This section details the connection settings required to configure Ometria as a destination in RudderStack.
Enter your Ometria API Token.
To get the Ometria API token, go to your your Ometria dashboard and navigate to Settings - API Keys. Then, click New API Key.
Under Contact Settings, you can choose the Marketing Optin status from the dropdown list. By default, it is set to Explicitly Opted Out. The different options are:
Explicitly Opted In: The customer is eligible for marketing
Explicitly Opted Out: The customer is not eligible for marketing
Not Specified: No option is specified
You can also pass this value in the identify call - refer to the Identify section below for more details. Note that the value set via the identify call will have a higher precedence.
Under SMS Channel Settings, you can enable Allow Marketing. This setting determines whether the contact is opted in or out for SMS marketing. By default, it is disabled.
Allow Transactional: Enabling or disabling this setting determines if the contact is opted in or out for transactional SMSes. By default, it is disabled.
You can additionally set the values for Allow Marketing and Allow Transactional via the identify call - refer to the Identify section below for more details. Note that the value set via the identify call will have a higher precedence.
Finally, click Next. Ometria will now be enabled as a destination in RudderStack.
Identify
The identify call lets you add a new contact or update an already existing contact in Ometria.
Note that listingId and email fields are the mandatory fields for the identify call.
You can set the values for the Marketing Optin, Allow Marketing, and Allow Transactional fields from RudderStack dashboard. You can also send these values using an integrations object in the identify event payload, which will have higher precedence. The SMS channel fields dt_updated_marketing and dt_updated_transactional can also be passed using this object.
The listingId is the ID specific to a contact in a particular Ometria collection. Note that the listingId specified in the integrations object will have a higher precedence than the one present in the traits.
A few things to keep in mind while making the identify call:
The phoneNumber field must follow the E.164 format. Otherwise, it will be set to null.
The custom_fields are mapped to the properties and will be the used in the track call too.
If custom_fields is not provided, then RudderStack will create that object with extra fields. Note that these fields must be different from the ones mentioned in the mapping list mentioned in the Identify Mapping section below, i.e, the non-default fields.
Inside the integrations object, you can additionally send two timestamps - dt_updated_marketing and dt_updated_transactional. These timestamps must follow the ISO-8601 format.
Identify Mapping
The following table includes all identify fields with their relative mapping to the Ometria fields:
RudderStack Field
Ometria Field
userId / anonymousId
customer_id
email
email
listingId
id
firstName/first_name/firstname
firstname
middleName/ middle_name / middlename
middlename
lastName/last_name/lastname
lastname
phoneNumber
phone_number
collection
@collection
prefix
prefix
dateOfBirth
date_of_birth
countryId
country_id
timezone
timezone
timestampAcquired
timestamp_acquired
timestampSubscribed
timestamp_subscribed
timestampUnsubscribed
timestamp_unsubscribed
storeIds
store_ids
gender
gender
removeFromLists
@remove_from_lists
addToLists
@add_to_lists
custom_fields
properties
forceOptin
@force_optin
merge
@merge
In addition to the above fields, the customer name can also be sent using the name field. If the name consists of two words, then firstname and lastname will be automatically set.
Track
The track call lets you send custom events to Ometria. Note that track also supports ecommerce events and sends them using the Ometria Order Object.
Note that userId and email are the mandatory fields for the track call. event_id is required for custom events. If not provided, RudderStack will populate the field with messageId.
A sample track call for a custom event is as shown:
The event name must be provided in the track call.
The custom_fields property is mapped to the properties object in Ometria. If it is not provided, the non-default Ometria fields will be taken as custom fields.
The timestamp field follows the ISO-8601 format. If it is not specified in the correct format, the call will be dropped - i.e., not be sent to Ometria.
Ometria Custom Event
The following table includes all RudderStack fields set as custom events in the track call, with their relative mapping to the Ometria fields:
The track call also lets you record order-related information like order_id, grandtotal, timestamp, currency, etc.
RudderStack will create a customer object with userId, email, firstname and lastname from context.traits.
Note that order_id, timestamp, grand_total and currency are the mandatory fields for the orders event, while userId and email are required for customer object. You can pass email either via the identify call or the track call’s properties.
The supported order ecommerce events are as listed below:
order completed / complete/ order complete
order shipped / shipped
order pending / pending
A sample track call for an ecommerce order event is as shown:
Ometria requires the currency field to follow the ISO 4217 format. If it is invalid, the event will be dropped.
If custom_fields is not provided, the non-default fields are taken as custom fields. In the above example, field1 will be mapped as a custom_fields.
The products field is not mandatory. However, if provided, each object should contain product_id, quantity, and either subtotal or unit_price. If either of these fields are absent, then that object will be dropped and the track call will be made.
RudderStack will set the status field according to the event name. For instance, if event name is order pending status will be set to pending.
The field is_valid is always set to true. For more information on how to use this field, refer to this example.
Track Orders Mapping
The following table includes all fields in track call for ecommerce orders, with their relative mapping to the Ometria fields:
RudderStack Field
Ometria Field
order_id
id
timestamp
timestamp
grand_total
grand_total
subtotal
subtotal
discount
discount
shipping
shipping
tax
tax
currency
currency
web_id
web_id
ip_address
ip_address
channel
channel
store
store
payment_method
payment_method
shipping_method
shipping_method
shipping_address
shipping_address
billing_address
billing_address
coupon_code
coupon_code
custom_fields
properties
products
lineitems
shipping_address and billing_address should be an object.
Note that products is an array of objects. Every object in this array can contain the following fields:
RudderStack Field
Ometria Field
product_id
product_id
variant_id
variant_id
quantity
quantity
sku
sku
unit_price
unit_price
quantity_refunded
quantity_refunded
refunded
refunded
subtotal
subtotal
tax
tax
total
total
discount
discount
is_on_sale
is_on_sale
totals
totals
properties
properties
variant_options
variant_options
Note that variant_options listed above is an array of objects. It is not a mandatory field. However, if provided, each object in this array must contain the following fields:
RudderStack Field
Ometria Field
id
id
type
type
label
label
FAQ
How do I get the Ometria API Key?
To get the Ometria API token, go to your your Ometria dashboard and navigate to Settings - API Keys. Then, click New API Key.
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.