Configuring Integrations

Overview

MetaRouter gives you a high degree of control over the specific events and event parameters that you send to your Integration vendors. Continue on to learn more about all the options available to you through the MetaRouter UI.

Getting Started

First, navigate to the integrations tab. Then, add a new integration. If you can't find an integration you need, reach out to MetaRouter. We're constantly updating our integrations library with new vendors.

Parameter Types

Global

Global parameters represent parameters that are configured for every event you send. User IDs, timestamps, and other parameters can be configured at the Global level to ensure they're always handled the same way with every event.

Required Fields

Required fields are denoted with a red asterisk. These are typically connection details that are required to authenticate and send data to the correct vendor account. Examples include Account IDs, API keys, secrets, usernames, passwords, and other information that is required to send data to a vendor.

To find these value for each integration, please reach out to MetaRouter for vendor-specific documentation that will demonstrate where this information is located (typically within the vendor's UI).

Event

Event parameters only apply to an individual event and will not be applied outside of that event. You need to add your events in this section, along with any input parameters that you wish to manipulate, for every Integration you set up.

Common examples of Event parameters include but are not limited to: order values or quantities, form fill values like emails or phone numbers, and other properties that may only exist for a specific event.

📘

Your event schema is helpful for understanding which events and parameters are available to be mapped within your integrations.

Default

Default parameters tell the platform how you would like to handle events and parameters that you have not explicitly outlined via Global parameters or Event parameters. Default parameters are a catch-all that can ensure that events and parameters reach a vendor. If you do not map any Default parameters, no parameters will reach a vendor if not explicitly mapped by either Global or Event configurations.

A common example of a Default parameter would be a context field, for example context.device.type. You may want to apply a common transformation to keep the output value consistent for any event you send to an Integration.

Default parameters only apply where our platform recognizes a field that you have specified. In addition, Default parameters will always be overridden by Event parameters where a field has also been specified in the Event parameters section for a given Integration.

Key:Value Pairs

Key:value pairs are crucial to understanding how MetaRouter integrations are constructed and customized. Keys simply represent what you are tracking with an event, while values can represent strings, floats, booleans, or other values which we discuss in the below Transform Types section.

You will start with a set of input keys and values, and through the available Transform Types, you can modify an incoming key:value pair to an output key:value pair that would be sent to your vendors.

Starter Kits

MetaRouter offers Starter Kits that will pre-populate your Integrations with events. This is helpful for some Integrations that may require you to include certain outputs. Starter kits generally support a specific vertical and work best if you use the MetaRouter-provided event specs, such as for e-commerce, B2B, video, and mobile. Please reach out to MetaRouter for help on getting the most out of your Starter Kits, as well as for any transformations you may want to apply on top of the Starter Kits.

Transform Types

MetaRouter enables the following actions to transform events before they are sent your vendors:

Revisions

MetaRouter stores previous versions of your integrations that you can always revert back to. When you make changes to an integration, you will be able to save a revision. Then, you will need to perform a pipeline deployment to apply the change.

If you need to revert back to a prior revision, navigate to the pipeline where the integration is deployed and find the revision number that contains the configuration you'd like to deploy. Select this version and deploy your pipeline to apply the old version.

Deploying a New Integration

Deploying a new integration requires the following:

  • Add your integration to a pipeline
  • Add your pipeline to a configured cluster
  • Request a new event forwarder to your cluster specific to your integration

❗

All new integrations require a backend resource- a MetaRouter forwarder- in order to function. Please reach out to your account representative when adding new integrations in order to have a forwarder added to to your cluster. Only one forwarder per vendor is required for your cluster. Once the forwarder is added you can freely add the same integration to other pipelines within your cluster.