Conversions API

Conversions API Gateway: AWS App Runner Setup Guide

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

Prerequisites

Before you can deploy the Conversions API Gateway, ensure that you have:

  • Meta Pixel ID
  • Events Manager Admin access (partial access won’t work)
  • All website domains
  • DNS Provider access (required to configure your sub-domain)
  • Cloud provider admin access (for example, AWS)

Recommended: Enable Advanced Matching on your Meta Pixel to help maximize the performance of your Conversions API Gateway integration. With Advanced Matching, you can send hashed customer contact information along with your Pixel events, which can help you attribute more conversions and reach more people. See more details here.

The current version of Conversions API Gateway only supports Amazon Web Services (AWS) as a third-party cloud provider:

  • If you do not have an AWS account, you can create one by following this 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.


  • Select the Host yourself hosting option.


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


  • On the Select preferences step, choose the settings you would 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.


  • When asked to select a cloud provider, choose the AWS App Runner cloud setup option.


  • Deploy to AWS using App Runner.
    • Next, under Select your hosting region, choose your desired region. You can only set up the 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.


  • All fields will be pre-populated. Please don’t change the ProvisioningData and BootstrapInformation fields.
  • Click Create stack to begin the installation.
  • The creation process takes approximately 15 to 20 minutes, after which one output 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.
  • 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.

  • You will be asked to create an admin account at the first login to the Admin UI.
  • Select Log in after creating an admin account.
  • You will see the Conversions API Gateway Admin UI.
  • When you first view the site, the server and browser data may be at 0. This information should take 10 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, contact Meta to troubleshoot.
  • If events do not populate after 2 hours, please contact Meta.
  • You should now see Conversions API Gateway under your pixel settings.
  • Recommended Create a custom domain to optimize data routing, see this reference page for instructions.

See Also