Conversions API

Conversions API Gateway: Setup Guide

Use the following steps to set up the Conversions API Gateway.

Please ensure you have reviewed and completed the prerequisites for Conversions API Gateway before you go through this setup guide.

Step 1: Get Started and Begin Deployment

To begin the setup process, navigate to the Settings tab within Meta Events Manager. Under "Set up with Conversions API Gateway", click on Get Started.



  • Review the prerequisites for Conversions API Gateway and then select Next.

Select Preferences

  • Choose the settings you’d like to enable and then click Continue.

    • Enhance events can help to improve conversion attribution and maximize the performance benefits of events you currently share with Meta.
    • Conversions API Gateway health monitoring enables Meta to more effectively troubleshoot potential problems.


  • Next, under Select your hosting region, choose your desired region. You can only set up Conversions API Gateway in one region.
  • Click Next to open up Amazon Web Services (AWS) or click Copy URL to send to your organization’s AWS account administrator.

Step 2: Configure AWS and Install

Log in to AWS if you have not already done so.

  • A quick creation flow for the Conversions API Gateway stack will open.
  • A number of fields will be pre-populated, but please don’t change these aside from the Stack name, which you can rename based on your preference.
  • Complete the remaining fields. Admin Email and Admin Password will be used to access the Conversions API Gateway Admin UI.
  • Click Create stack to begin the installation.


  • The creation process takes approximately 30 to 40 minutes, after which three outputs will be written to the "Outputs" tab for the new AWS instance. You will know it is done when the Status says: CREATE_COMPLETE in the Stack info Tab.
  • Once complete, go to the Outputs tab.
  • (Recommended) Create a custom domain to help data routing, see step 4 below.
  • Take note of the CapigSetupURL, which you will need to provision the Conversions API Gateway UI.

Step 3: Verify Data Collection

To access the Conversions API Gateway Admin UI, use the CapigSetupURL within the Outputs tab (reference step 2). The CapigSetupURL can also be found within Events Manager.

  • Username is “AdminEmail” from step 2
  • Password is “AdminPassword” from step 2
  • Select Log in
  • You will see the Conversions API Gateway Admin UI site.
  • When you first view the site, the server and browser data may be at 0. This information should take 5 minutes to 2 hours to populate.
  • To check if the data is being collected, you can go to your website and refresh the page.
  • If events do not populate after 2 hours, please contact Meta.
  • You should now see Conversions API Gateway under your pixel settings.

(Recommended) Step 4: Add Custom Domain

Set up a custom domain within the Conversions API Gateway Admin UI. A custom domain is recommended as it may help optimize data routing and may reduce costs.

Note: You will need access to your DNS provider to add a custom domain

  • Log into the Conversions API Gateway Admin UI using the Username (AdminEmail) and Password (AdminPassword) created in step 2.
  • Navigate to Domain management on the left sidebar.
  • Enter a custom domain for your Conversions API Gateway, including a subdomain and root domain, and click Continue.


  • Next, create two DNS records leveraging the information on the Configure DNS page. You will need to navigate to your DNS provider to create the two records.
    • Steps for creating these records will vary depending on your DNS partner, so please refer to their documentation if you have any problems completing this step.

  • It may take a few minutes to validate your DNS. Once successfully validated, a green checkmark will appear and the custom domain will now be reflected in the Current domain section

Troubleshooting Setup Issues

Use these steps to troubleshoot issues when you set up Conversions API Gateway. For general troubleshooting, see Conversions API Gateway - Troubleshooting Errors and Warnings.

Browser Autocomplete Interferes With Setup

If you can't install the Conversion API Gateway because of expired provisioning data, even though you launched the installation from Event Manager, the browser autocomplete feature might be automatically populating previously used information.

Diagnostics

  1. Launch installation from Event Manager and save the provisioning data for later examination.
  2. Click Copy URL and save the copied URL to any text editor such as Notepad.
  3. Click Begin deployment to launch the AWS creation page.
  4. On the AWS creation page, find ProvisioningData and verify that the entry matches the URL that you copied previously. If they don't match, autocomplete is on and you must turn it off.

Resolution

For FireFox browsers, use the following steps:

  1. Click the Firefox menu icon (three bars at the top right of the screen).
  2. Click on Settings.
  3. Select the Privacy & Security settings.
  4. Scroll to History and for Firefox will choose Use custom settings for history.
  5. Unselect Remember search and form history.
  6. Your changes are saved automatically.

For Chrome browsers, use the following steps:

  1. Click the Chrome menu icon (three dots at the top right of screen).
  2. Click on Settings.
  3. Select the Autofill settings.
  4. Expand the appropriate area.
  5. Toggle the autofill setting off.
  6. Your changes are saved automatically.

Additional Configurations

Meta Events Manager allows you to add new connections, configure additional domains and add new Pixels to your existing Conversions API Gateway connection. To define these, please follow the below steps:

Click on Partner Integrations, which appears on left side of page:



Select Conversions API Gateway to open the Conversions API Gateway.



In this screen you can view:

  • Website events
    1. Events are website actions that are set up on your Conversions API Gateway site and are separately being sent to Meta using the Meta Pixel.
  • Website domains
    1. Websites your Conversions API Gateway is configured to connect with through the Pixel.


Click on the Settings and select the action you would like to take.

Adding Another Conversions API Gateway Connection

This allows you to set up a new Conversions API Gateway instance with another Meta Pixel. Below shows the first step in the dialog, similar to the one from the Meta Pixel settings page. Next, you will be asked to select a Meta Pixel for the installation of your new Conversions API Gateway connection.

Adding Another Meta Pixel to an Existing Conversions API Gateway Connection

This option allows you to onboard another Meta Pixel on an existing Conversions API Gateway installation.

To begin the setup process, navigate to the Settings tab within Meta Events Manager. Under the section “Existing Conversions API Gateways”, click the Connect button:














See Also