Overview

MetaRouter Integration Transformations are how you control your integration’s data mappings and manipulations, granting access to and control over each data parameter that is passed from your digital property to a downstream destination.

MetaRouter refers to a set of transformations applied to an integration as a Playbook.

Key Benefits

Improves transparency into what data is actually being passed to a downstream vendor.
Makes detailed integration configuration available to non-technical members of your organization.
Provides highly flexible & complex integration configuration where necessary.
Data is never stored at rest prior to or during transformation. All transformations are performed while an event is in-transit between the browser and destination.

Accessing Playbooks

Login to your enterprise.metarouter.io account.
In the lefthand navigation bar, select the Integrations tab.
In the upper lefthand corner, click the New Integration button and choose an Integration you’d like to configure.
If it isn’t already selected, click the Event Mappings tab. This will bring you to your Playbook configurations page.

Playbook Sections

Playbooks contain four sections that contain mappings. Some mappings are required.

Parameters

Parameters contain required information that is passed to the destination’s API outside of individual events. Typically this information with help you authenticate into the destination API.

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.

Event Specific

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 Playbook you configure.

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 or set of events.

Default

Default parameters tell MetaRouter how you would like to handle events and parameters that you have not explicitly outlined via Global parameters or Event parameters. 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 (e.g. context.device.type). You may want to apply a Default transformation to keep the output value consistent for any event you send to a destination, unless it has been mapped with different logic within a specific event.

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

Customizing Playbooks

Playbooks provide five primary customization types. Click the following links to learn more about each configuration type:

Pre-configured Events & Mappings

When you build a Playbook, you may notice some events will be included automatically. The set of Parameters and mappings that are automatically included is called a Starter Kit. Each integration will contain various events and mappings depending on the amount of common mappings that we see for each integration.

MetaRouter may be able to build custom Starter Kits utilizing your specific event inputs. Please reach out to your Customer Success Manager to learn more about this process.

Downloading & Uploading Playbooks

Playbooks can be downloaded, edited with your code editor, and uploaded to the UI to change your event configurations. This may be an easier way to manage playbooks for advanced MetaRouter users.

Within an Integration, hover over the three dots icon next to the Save as New Revision button. Click the Download button and open the folder you just downloaded.

The folder will contain two files: a connection.yaml and playbook.yaml. The playbook.yaml file will contain all of your event mappings in JSON format. You can edit your playbook.yaml file and re-upload it by navigating back to the three dots icon and clicking the Upload button. You may upload the playbook.yaml file without the connection.yaml file. Editing the connection.yaml file should generally be avoided with the exception of specific use cases that are recommended by the MetaRouter Customer Success team.

Note that the downloaded file is a zip file (not a gzip as the “.gz” file extension may imply).