[Zoho CRM] Meta Leads API by Stape

Stape developed the Meta Leads API app to help you easily report your Leads' progress status as conversion events to your CAPI Gateway, server GTM container, or Signals Gateway.

With this app, you can configure the relevant fields once, and it will automatically monitor the stages of your Leads. It will then send the corresponding conversion events to CAPI Gateway, server GTM container, or Signals Gateway, ensuring accurate and efficient tracking of your lead conversions.

App installation

1.1 Install Stape Meta Leads API for Zoho CRM on the Zoho CRM marketplace.

1.2 Confirm Terms of Service and provide the app with needed access:

1.3 Select who should have access to the app. We recommend choosing "Install for all users" at this step.

1.4 Once you click "Confirm" you will be redirected to the page that is shown below, you need to reload this page.

1.5 To find the "Settings" of the app, you should click on three dots as shown on the screenshot below and click on "Stape App":

1.6 Click the "Connect with Zoho CRM" button.

1.7 You will be redirected to a new tab; here, click "Accept".

Integration methods: CAPI Gateway, Signals Gateway, or server GTM

• If you'd like to proceed with CAPI Gateway, please follow these steps.
• If you'd like to proceed with Signals Gateway, please follow these steps.
• If you'd like to proceed with Server GTM, please follow these steps.

Integration method depends on your tracking setup and goals, and/or on current experience with Stape. 

App configuration | CAPI Gateway

Before you start

Make sure you have an active Stape account with Meta Conversions API Gateway.

If you don’t have an account on Stape, please create one or log in if you already have. In the main menu click “More Gateways” → “Meta CAPIG” → “Create CAPIG” on the top right.

Add name, email, and server location for new CAPIG. Then, choose the subscription plan and add billing details.

After creating Meta Conversions API Gateway in your Stape account, connect your Meta Dataset (Pixel) - just click "Add data source" → authorize in Meta → select the Business Manager and Dataset (Pixel) you want to connect.

To increase the events match quality, please enable “Automatic advanced matching”.

App setup

The setting process can be divided into two parts:

• Meta and Stape accounts data
• Zoho CRM fields 

You will see the app "Settings" page that needs to be configured:

Meta Dataset (Pixel) ID

Meta Dataset (Pixel) ID- unique identifier that is used to configure integrations and view events in Events Manager. You can find it in your Meta account in Data Sources’ “Settings” tab. To find Meta Dataset ID follow the steps below.

1. Log into your Facebook Business Manager → Click "All tools" in the left-hand menu options.

2. On the pop-up menu, find "Event Manager" → "Data Sources".

3. Go to the "Settings" tab and find Dataset ID.

CAPIG API Key

CAPIG API Key - alphanumeric string value that is needed for app identification. Find CAPIG API Key in the CAPIG settings section of your Stape account.

To find CAPIG API Key log into your Stape account → “More Gateways” → “Meta CAPIG” → choose the right CAPIG from the drop-down menu.

In the "CAPIG settings" see "Show CAPIG API Key".

Map your CRM fields to conversion event parameters

- (Optional) Pick a field where Meta Lead ID is stored. Note dropdown will only reflect custom fields.

- Configure additional User data you’d like to send to Meta, by choosing a parameter in the left dropdown and selecting an appropriate field in the right-side one.

- Application sends conversion Events based on statuses of your Leads, whenever a lead reaches a status you define, a corresponding event will be sent towards your Meta Dataset (Pixel). So we need to configure it by choosing one of two approaches:

• In the left-side dropdown, select a Lead stage to trigger an event. In a box to the right, type the event name you’d like to send to Meta.

• Select the ‘Send all stages’ checkbox if you want to send all Leads stages as events to Meta. Events are then named automatically and consist of a Lead status name. You can also select stages to ignore in this case.

Once done, click “Save and Connect”. Once you see a success message your installation is complete and the application will send conversion events in the background based on your settings.

App configuration | Signals Gateway

Before you start

Make sure you have an active Stape account with Signals Gateway

If you don’t have an account on Stape, please create one or log in if you already have. In the main menu click “Signals Gateway” → “Create Signals Gateway” on the top right.

Add name, email, and server location for new Signals Gateway. Then, choose the subscription plan.

App setup

The setting process can be divided into two parts:

2.1 Signals and Stape accounts data
2.2 Zoho CRM fields

Signals Gateway Pixel

Signals Gateway Pixel ID - unique identifier that is used to configure integrations and view events in Signals Gateway. You can find it in your Signals Gateway account in the Data Sources tab:

1. Log into your Signals Gateway  → Click "Data Sources" in the left-hand menu.

2. Choose your data source in the dashboard.

2. Click "Setup guide" → and find your Pixel ID on the top of the menu

Signals Gateway API Key

Signals Gateway API Key - alphanumeric string value that is needed for app identification. Find Signals Gateway API Key in the Gateway settings section of your Stape account. 

1. Log in to your Stape account. 
2. Select Signals Gateway.
3. In the Settings section, you will see the Gateway API Key.

Zoho CRM fields

Next you need to map your CRM fields to conversion event parameters.

- (Optional) Pick a field where Meta Lead ID is stored.

- Configure additional User data you’d like to send to Meta, by choosing a parameter in the left dropdown and selecting an appropriate field in the right-side one.

- Application sends conversion Events based on statuses of your Leads, whenever a deal reaches a status you define, a corresponding event will be sent towards your Signals Gateway Pixel. So we need to configure it by choosing one of two approaches:

• In the left-side dropdown, select a Lead status to trigger an event; in a box to the right, type the event name you’d like to send to Signals Gateway pipeline.

• Select the ‘Send all stages’ checkbox if you want to send all Leads stages as events to Signals Gateway pipeline. Events are then named automatically and consist of a Lead status name. You can also select stages to ignore in this case.

Once done, click “Save and Connect”. Once you see a success message your installation is complete and the application will send conversion events in the background based on your settings.

App configuration | Server GTM

Before you start

Make sure you have an active Stape account with a server GTM container hosted on Stape.

If you don’t have an account on Stape, please create one or log in if you already have. In the main menu click “sGTM” → “Create container” on the top right.

Add your container name, Container Configuration that you copied from your Google Tag Manager Server Container, and select server location. Click Create Container.

App setup

The setting process can be divided into two parts:

2.1 Stape account data
2.2 Zoho CRM fields

Container API Key

Container API Key - alphanumeric string value that is needed for app identification. Find Container API Key in the Container settings section of your Stape account: select sGTM container and in the Settings section, you will see the API Key.

Zoho CRM fields

Next you need to map your CRM fields to conversion event parameters.

- (Optional) Pick a field where Meta Lead ID is stored.

- Configure additional User data you’d like to send to server GTM, by choosing a parameter in the left dropdown and selecting an appropriate field in the right-side one.

- Application sends conversion Events based on statuses of your Leads, whenever a deal reaches a status you define, a corresponding event will be sent towards your server GTM container. So we need to configure it by choosing one of two approaches:

• In the left-side dropdown, select a Lead status to trigger an event; in a box to the right, type the event name you’d like to send to server GTM.

• Select the ‘Send all stages’ checkbox if you want to send all Leads statuses as events to server GTM. Events are then named automatically and consist of a Lead status name. You can also select stages to ignore in this case.

Once done, click “Save and Connect”. Once you see a success message your installation is complete and the application will send conversion events in the background based on your settings.

Settings editing

If you have some changes in the funnel or you want to change the events sent to Meta, you can always edit your app configuration.

To do this, go back to settings page via a dedicated item in the side menu or go to “Installed Apps” section of the marketplace:

FAQ

- Is there a subscription involved to use the application?

Application is distributed for free, but you will need a functioning Stape account with active CAPI Gateway, GTM Container or Signals Gateway. It depends on your tracking setup and/or current experience with Stape.

- How does the app trigger conversion events?

Application will react to status changes of your Lead entities. Triggers are configured in app settings.

- How can I make sure the app actually works?

With CAPI Gateway integration you should see events you’ve configured in your Events Manager. Please note the user interface may take up to 30 min to reflect most recent events sent.

With Signals Gateway integration you should see events you’ve configured in your Signals Gateway Data Source. Please note the user interface may take up to 30 min to reflect most recent events sent.

With server GTM integration the assumed approach for debugging is webhooks. 

- Do you provide templates for server GTM integration?

Yes, you can find a pre-built server container template in our GitHub.