Create Lead with HelloLeads API on New Lead Form Entry from Google Ads API

Pipedream makes it easy to connect APIs for HelloLeads, Google Ads and 2,700+ other apps remarkably fast.

Trigger workflow on

New Lead Form Entry from the Google Ads API

Next, do this

Create Lead with the HelloLeads API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Ads trigger and HelloLeads action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Lead Form Entry trigger
1. Connect your Google Ads account
2. Select a Use Google Ads As
3. Optional- Select a Managed Account
4. Configure timer
5. Select a Lead Form ID
6. Configure docsAlert
Configure the Create Lead action
1. Connect your HelloLeads account
2. Select a List Key
3. Configure First Name
4. Optional- Configure Last Name
5. Optional- Configure Designation
6. Optional- Configure Company
7. Optional- Configure Email
8. Optional- Configure Phone
9. Optional- Configure Mobile
10. Optional- Configure Fax
11. Optional- Configure Address Line 1
12. Optional- Configure Address Line 2
13. Optional- Configure City
14. Optional- Configure State
15. Optional- Configure Postal Code
16. Optional- Configure Country
17. Optional- Configure Website
18. Optional- Configure Notes
19. Optional- Configure Interests
20. Optional- Configure Category
21. Optional- Configure Tags
22. Optional- Configure Mobile Code
23. Optional- Configure Deal Size
24. Optional- Select a Potential
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Lead Form Entry on Google Ads

Description:Emit new event for new leads on a Lead Form. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/lead_form_submission_data)

Version:0.0.4

Key:google_ads-new-lead-form-entry

View on GitHub

Google Ads Overview#

The Google Ads API lets you programmatically manage your Google Ads data and
campaigns. You can use the API to automate common tasks, such as:

Creating and managing campaigns
Adding and removing keywords
Adjusting bids

You can also use the API to get information about your campaigns, such as:

Campaign stats
Keyword stats
Ad performance

The Google Ads API is a powerful tool that lets you manage your Google Ads data
and campaigns programmatically. With the API, you can automate common tasks,
such as creating and managing campaigns, adding and removing keywords, and
adjusting bids. You can also use the API to get information about your
campaigns, such as campaign stats, keyword stats, and ad performance.

Customizing API requests from within the Pipedream workflow builder

The Pipedream components interact with Google Ads API through an interal proxy service, which protects Pipedream's developer token.

The component accepts a standard Google Ads API request object with the following structure:

const googleAdsReq = {
  method: "get|post|put|delete", // HTTP method
  url: "/v18/...", // Google Ads API endpoint path
  headers: {
    Authorization: `Bearer ${this.googleAds.$auth.oauth_access_token}`,
  },
  data: {}, // Optional request body for POST/PUT requests
};

To make different API calls while using the proxy:

Modify the url path to match your desired Google Ads API endpoint
Update the method to match the required HTTP method
Add any necessary request body data in the data field
Include any required headers (Authorization is automatically included)

Example for a custom query:

const googleAdsReq = {
  method: "post",
  url: "/v16/customers/1234567890/googleAds:search",
  headers: {
    Authorization: `Bearer ${this.googleAds.$auth.oauth_access_token}`,
  },
  data: {
    query: "SELECT campaign.id, campaign.name FROM campaign",
  },
};

The proxy endpoint will remain the same: https://googleads.m.pipedream.net

Using Google Ads with the Connect API Proxy

To interface with Google Ads via the Connect API Proxy, you need to nest the request like this:

Important notes:

The upstream URL in this case is Pipedream's proxy service for Google Ads: https://googleads.m.pipedream.net
Like in the above examples, you'll define the Google Ads URL with the url param in the body
The method to the Connect Proxy should always be a POST, since it's actually targeting the Google Ads proxy (you can define the method for the Google Ads request in options.body.method)

Using the Pipedream SDK

const pd = createBackendClient({
  apiHost: process.env.API_HOST,
  credentials: {
    clientId: process.env.CLIENT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  },
  environment: process.env.ENVIRONMENT,
  projectId: process.env.PROJECT_ID,
});

const pdGoogleAdsUrl = "https://googleads.m.pipedream.net";

const resp = await pd.makeProxyRequest(
  {
    searchParams: {
      external_user_id: process.env.EXTERNAL_USER_ID,
      account_id: process.env.ACCOUNT_ID,
    },
  },
  {
    url: pdGoogleAdsUrl,
    options: {
      method: "POST",
      body: {
        url: "/v19/customers:listAccessibleCustomers",
        method: "GET",
        // data: {} // If you need to send a body with a POST request, define it here
      },
    },
  }
);

Using the Connect REST API

Remember to use the Base64 encoded Pipedream endpoint for Google Ads: https://googleads.m.pipedream.net

curl -X POST "https://api.pipedream.com/v1/connect/{your_project_id}/proxy/{url_safe_base64_encoded_url}?external_user_id={external_user_id}&account_id={apn_xxxxxxx}" \
  -H "Authorization: Bearer {access_token}" \
  -H "x-pd-environment: {development | production}" \
  -d '{
    "url": "/v19/customers:listAccessibleCustomers",
    "method": "GET",
    # "data": {} # If you need to send a body with a POST request, define it here
  }'

Trigger Code#

import common from "../common/common.mjs";
import sampleEmit from "./test-event.mjs";

const { googleAds } = common.props;

export default {
  ...common,
  key: "google_ads-new-lead-form-entry",
  name: "New Lead Form Entry",
  description: "Emit new event for new leads on a Lead Form. [See the documentation](https://developers.google.com/google-ads/api/fields/v18/lead_form_submission_data)",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  sampleEmit,
  props: {
    ...common.props,
    leadFormId: {
      propDefinition: [
        googleAds,
        "leadFormId",
        (({
          accountId, customerClientId,
        }) => ({
          accountId,
          customerClientId,
        })),
      ],
    },
    docsAlert: {
      type: "alert",
      alertType: "info",
      content: "If needed, see Google's documentation on [submission fields](https://developers.google.com/google-ads/api/reference/rpc/v18/LeadFormSubmissionField) and [custom submission fields](https://developers.google.com/google-ads/api/reference/rpc/v18/CustomLeadFormSubmissionField).",
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New Lead";
    },
    getItems() {
      const {
        accountId, customerClientId, leadFormId,
      } = this;
      return this.googleAds.getLeadFormData({
        accountId,
        customerClientId,
        leadFormId,
      });
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Ads	`googleAds`	`app`	This component uses the Google Ads app.
Use Google Ads As	`accountId`	`string`	Select a value from the drop down menu.
Managed Account	`customerClientId`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Lead Form ID	`leadFormId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

Google Ads uses OAuth authentication. When you connect your Google Ads account, Pipedream will open a popup window where you can sign into Google Ads and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Google Ads API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/adwords

About Google Ads#

Reach customers wherever they are. Show up at the right time and place across the vast Google Ads ecosystem.

Action#

Create Lead on HelloLeads

Description:Adds a new lead into the HelloLeads system. [See the documentation](https://github.com/PipedreamHQ/pipedream/files/13168532/HelloLeads_CRM_API_Documentation_POST_Method.pdf)

Version:0.0.1

Key:helloleads-create-lead

View on GitHub

HelloLeads Overview#

The HelloLeads API integrates with Pipedream to automate your lead management processes. By leveraging this API on Pipedream, you can streamline contact syncing, lead tracking, and perform actions based on lead status changes. With serverless workflows, you can connect HelloLeads with various apps like CRMs, communication platforms, or data analysis tools to enhance lead engagement, follow-up efficiency, and data-driven decision-making.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import helloleads from "../../helloleads.app.mjs";
import {
  clearObj,
  parseObj,
} from "../../common/utils.mjs";

export default {
  key: "helloleads-create-lead",
  name: "Create Lead",
  version: "0.0.1",
  description: "Adds a new lead into the HelloLeads system. [See the documentation](https://github.com/PipedreamHQ/pipedream/files/13168532/HelloLeads_CRM_API_Documentation_POST_Method.pdf)",
  type: "action",
  props: {
    helloleads,
    listKey: {
      propDefinition: [
        helloleads,
        "listKey",
      ],
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the lead.",
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the lead.",
      optional: true,
    },
    designation: {
      type: "string",
      label: "Designation",
      description: "Designation of the lead.",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company",
      description: "Lead organization name.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "Primary email address of the lead.",
      optional: true,
    },
    phone: {
      type: "integer",
      label: "Phone",
      description: "Work phone number of the lead.",
      optional: true,
    },
    mobile: {
      type: "integer",
      label: "Mobile",
      description: "Mobile phone number of the lead.",
      optional: true,
    },
    fax: {
      type: "integer",
      label: "Fax",
      description: "Fax number of the lead.",
      optional: true,
    },
    addressLine1: {
      type: "string",
      label: "Address Line 1",
      description: "Address line1 of the lead.",
      optional: true,
    },
    addressLine2: {
      type: "string",
      label: "Address Line 2",
      description: "Address line2 of the lead.",
      optional: true,
    },
    city: {
      type: "string",
      label: "City",
      description: "City that the lead belongs to.",
      optional: true,
    },
    state: {
      type: "string",
      label: "State",
      description: "State that the lead belongs to.",
      optional: true,
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Zip code of the region that the lead belongs to.",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "Country that the lead belongs to.",
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "Website reference of the lead.",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Specify any other details about the lead.",
      optional: true,
    },
    interests: {
      type: "string[]",
      label: "Interests",
      description: "A list of Product/Interest which offered by you is interested to Lead. `(Don't use special characters)`.",
      optional: true,
    },
    category: {
      type: "string",
      label: "Category",
      description: "Customer group of a Lead. `(Don't use special characters)`.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Short tags (Tagging words) on lead. `(Do not use special characters)`.",
      optional: true,
    },
    mobileCode: {
      type: "string",
      label: "Mobile Code",
      description: "Mobile country code.",
      optional: true,
    },
    dealSize: {
      type: "string",
      label: "Deal Size",
      description: "Deal value of the business.",
      optional: true,
    },
    potential: {
      type: "string",
      label: "Potential",
      description: "How potential is the customer. By default, it will be Low.",
      options: [
        "High",
        "Medium",
        "Low",
        "Not Relevant",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      helloleads,
      listKey,
      firstName,
      lastName,
      email,
      mobile,
      addressLine1,
      addressLine2,
      postalCode,
      interests,
      tags,
      mobileCode,
      dealSize,
      ...data
    } = this;

    if (!email && !mobile) throw new ConfigurationError("You must fill in at least Email or Mobile");

    const response = await helloleads.createLead({
      $,
      data: clearObj({
        list_key: listKey,
        first_name: firstName,
        last_name: lastName,
        email: email,
        mobile: mobile,
        address_line1: addressLine1,
        address_line2: addressLine2,
        postal_code: postalCode,
        interests: interests && parseObj(interests).toString(),
        tags: tags && parseObj(tags).toString(),
        mobile_code: mobileCode,
        deal_size: dealSize,
        ...data,
      }),
    });

    $.export("$summary", `A new lead with Id: ${response.lead_id} created successfully!`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
HelloLeads	`helloleads`	`app`	This component uses the HelloLeads app.
List Key	`listKey`	`string`	Select a value from the drop down menu.
First Name	`firstName`	`string`	First name of the lead.
Last Name	`lastName`	`string`	Last name of the lead.
Designation	`designation`	`string`	Designation of the lead.
Company	`company`	`string`	Lead organization name.
Email	`email`	`string`	Primary email address of the lead.
Phone	`phone`	`integer`	Work phone number of the lead.
Mobile	`mobile`	`integer`	Mobile phone number of the lead.
Fax	`fax`	`integer`	Fax number of the lead.
Address Line 1	`addressLine1`	`string`	Address line1 of the lead.
Address Line 2	`addressLine2`	`string`	Address line2 of the lead.
City	`city`	`string`	City that the lead belongs to.
State	`state`	`string`	State that the lead belongs to.
Postal Code	`postalCode`	`string`	Zip code of the region that the lead belongs to.
Country	`country`	`string`	Country that the lead belongs to.
Website	`website`	`string`	Website reference of the lead.
Notes	`notes`	`string`	Specify any other details about the lead.
Interests	`interests`	`string[]`	A list of Product/Interest which offered by you is interested to Lead. `(Don't use special characters)`.
Category	`category`	`string`	Customer group of a Lead. `(Don't use special characters)`.
Tags	`tags`	`string[]`	Short tags (Tagging words) on lead. `(Do not use special characters)`.
Mobile Code	`mobileCode`	`string`	Mobile country code.
Deal Size	`dealSize`	`string`	Deal value of the business.
Potential	`potential`	`string`	Select a value from the drop down menu:`HighMediumLowNot Relevant`

Action Authentication#

HelloLeads uses API keys for authentication. When you connect your HelloLeads account, Pipedream securely stores the keys so you can easily authenticate to HelloLeads APIs in both code and no-code steps.

To retrieve your API Authentication Key,