Search

General API Integration Guide

How it works

Magnify supports many tools through API integration. Once a tool has been authenticated with Magnify, the data ingestion process will begin. Upon completion, a list of all ingested objects and fields will be provided for review. During the review process, object(s) and/or field(s) may require additional information (e.g. specifying a Universal Account and/or User ID). Additionally, it is possible to specify objects or fields to be hidden in Magnify.
After objects and fields have been ingested and properly identified, they will be available within Magnify, providing you the ability to create targeted customer segments for motion creation throughout the customer lifecycle.

This guide applies to all supported integrations, with the exception of the following systems:
  • Salesforce
  • Slack
  • Data Warehouses

For integrations not covered in this guide please refer to our General OAuth Integration Guide or Data Warehouse Integration Guide.

Requirements

  • API Token from system to be integrated with Magnify
  • Identify which fields map to the universal and unique account and user identifiers (in Salesforce this is typically Account ID and Contact ID)
  • Identify any custom objects that should be included and/or excluded from the Magnify UI

Integration Walkthrough

  1. Login to your Magnify instance and navigate to the Integrations menu.

  1. On the integrations dashboard, you can either locate the tool you’d like to integrate with from the Available Connections at the bottom of the page or simply click Add Connection to begin the setup process.

Screenshot 2024-11-15 at 2.03.29 PM.png

  1. Name your authentication and provide the API Token, along with any other required details specific to the system you are integrating with (e.g. domain name of instance). Click Create.

  2. If done correctly, you will be taken back to the integrations menu where you will see the integration appear under Your Connections. The status will reflect Processing while the integration is being setup and report as Live once the system is fully integrated with Magnify.

Screenshot_2024-11-15_at_2_29_45 PM.png

  1. Once your tool has been successfully integrated with Magnify, the data ingestion process will begin. Please allow up to 1 week for data ingestion to fully complete.

  2. After the data ingestion process has completed, Magnify will provide you with a mapping file that will need to be completed with the following information:

    • Identify the Universal Account and/or User ID to accurately link data across various systems. This is the unique identifier that exists in each system and allows Magnify to understand that Account/User Foobar in system A is the same as Account/User Foobar in system B.
    • Identify which objects and/or fields should be available for usage within Magnify. You may wish to only expose a subset of the ingested data to be available within the platform for usage.
Please refer to the Metadata Configuration guide for more information on completing the mapping file.
  1. Once the file has been completed and returned, Magnify will update the necessary mappings for any ingested objects and fields and the integration setup will be complete.

Updated