Create Ad Group with Nextdoor Ads API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Nextdoor Ads, Typeform and 2,500+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Ad Group with the Nextdoor Ads 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 Typeform trigger and Nextdoor Ads action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Ad Group action
1. Connect your Nextdoor Ads account
2. Select a Advertiser ID
3. Select a Campaign ID
4. Configure Name
5. Select one or more Placements
6. Configure Bid Amount
7. Select a Bid Pricing Type
8. Configure Budget Amount
9. Configure Start Time
10. Optional- Configure End Time
11. Configure Number Of Frequency Caps
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  sampleEmit,
};

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
Typeform	`typeform`	`app`	This component uses the Typeform app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Ad Group on Nextdoor Ads

Description:Creates an ad group based on the input payload for an existing campaign. [See the documentation](https://developer.nextdoor.com/reference/adgroup-create).

Version:0.0.1

Key:nextdoor-create-ad-group

View on GitHub

Action Code#

import app from "../../nextdoor.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "nextdoor-create-ad-group",
  name: "Create Ad Group",
  description: "Creates an ad group based on the input payload for an existing campaign. [See the documentation](https://developer.nextdoor.com/reference/adgroup-create).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    advertiserId: {
      propDefinition: [
        app,
        "advertiserId",
      ],
    },
    campaignId: {
      propDefinition: [
        app,
        "campaignId",
        ({ advertiserId }) => ({
          advertiserId,
        }),
      ],
    },
    name: {
      description: "The name of the ad group.",
      propDefinition: [
        app,
        "name",
      ],
    },
    placements: {
      type: "string[]",
      label: "Placements",
      description: "The placements for the ad group.",
      options: [
        "RHR",
        "FEED",
        "FSF",
      ],
    },
    bidAmount: {
      type: "string",
      label: "Bid Amount",
      description: "The bid amount for the ad group. The value must be a string in the format `USD 10` as an example.",
    },
    bidPricingType: {
      type: "string",
      label: "Bid Pricing Type",
      description: "The bid pricing type for the ad group. The value must be one of `CPM`.",
      options: [
        "CPM",
      ],
    },
    budgetAmount: {
      type: "string",
      label: "Budget Amount",
      description: "The budget amount for the ad group. The value must be a string in the format `USD 10` as an example.",
    },
    startTime: {
      propDefinition: [
        app,
        "startTime",
      ],
    },
    endTime: {
      propDefinition: [
        app,
        "endTime",
      ],
    },
    numberOfFrequencyCaps: {
      type: "integer",
      label: "Number Of Frequency Caps",
      description: "The number of frequency caps to be collected. Defaults to `1`.",
      default: 1,
      reloadProps: true,
    },
  },
  methods: {
    frequencyCapsPropsMapper(prefix) {
      const {
        [`${prefix}maxImpressions`]: maxImpressions,
        [`${prefix}numTimeunits`]: numTimeunits,
        [`${prefix}timeunit`]: timeunit,
      } = this;

      return {
        max_impressions: maxImpressions,
        num_timeunits: numTimeunits,
        timeunit,
      };
    },
    getFrequencyCapsPropDefinitions({
      prefix,
      label,
    } = {}) {
      return {
        [`${prefix}maxImpressions`]: {
          type: "integer",
          label: `${label} - Max Impressions`,
          description: "The maximum number of impressions.",
        },
        [`${prefix}numTimeunits`]: {
          type: "integer",
          label: `${label} - Number of Time Units`,
          description: "The number of time units for frequency caps.",
        },
        [`${prefix}timeunit`]: {
          type: "string",
          label: `${label} - Time Unit`,
          description: "The time unit for frequency caps.",
          options: [
            "MINUTE",
            "HOUR",
            "DAY",
            "WEEK",
            "MONTH",
          ],
        },
      };
    },
    createAdGroup(args = {}) {
      return this.app.post({
        path: "/adgroup/create",
        ...args,
      });
    },
  },
  async additionalProps() {
    const {
      numberOfFrequencyCaps,
      getFrequencyCapsPropDefinitions,
    } = this;

    return utils.getAdditionalProps({
      numberOfFields: numberOfFrequencyCaps,
      fieldName: "frequency cap",
      getPropDefinitions: getFrequencyCapsPropDefinitions,
    });
  },
  async run({ $ }) {
    const {
      createAdGroup,
      advertiserId,
      campaignId,
      name,
      placements,
      bidAmount,
      bidPricingType,
      budgetAmount,
      startTime,
      endTime,
      numberOfFrequencyCaps,
      frequencyCapsPropsMapper,
    } = this;

    const response = await createAdGroup({
      $,
      data: {
        advertiser_id: advertiserId,
        campaign_id: campaignId,
        name,
        placements: utils.parseArray(placements),
        bid: {
          amount: bidAmount,
          pricing_type: bidPricingType,
        },
        budget: {
          amount: budgetAmount,
          budget_type: "DAILY_CAP_MONEY",
        },
        start_time: startTime,
        end_time: endTime,
        frequency_caps: utils.getFieldsProps({
          numberOfFields: numberOfFrequencyCaps,
          fieldName: "frequency cap",
          propsMapper: frequencyCapsPropsMapper,
        }),
      },
    });

    $.export("$summary", `Successfully created ad group with ID \`${response.id}\`.`);
    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
Nextdoor Ads	`app`	`app`	This component uses the Nextdoor Ads app.
Advertiser ID	`advertiserId`	`string`	Select a value from the drop down menu.
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the ad group.
Placements	`placements`	`string[]`	Select a value from the drop down menu:`RHRFEEDFSF`
Bid Amount	`bidAmount`	`string`	The bid amount for the ad group. The value must be a string in the format `USD 10` as an example.
Bid Pricing Type	`bidPricingType`	`string`	Select a value from the drop down menu:`CPM`
Budget Amount	`budgetAmount`	`string`	The budget amount for the ad group. The value must be a string in the format `USD 10` as an example.
Start Time	`startTime`	`string`	The start time in ZonedDateTime format. This date time should be in the future. Eg. `2023-08-03T10:15:30-07:00[America/Los_Angeles]`. See the documentation
End Time	`endTime`	`string`	The end time in ZonedDateTime format. If the End Time is not passed in, then the AdGroup is assumed to be running continuously. Eg. `2023-08-03T10:15:30-07:00[America/Los_Angeles]`. See the documentation
Number Of Frequency Caps	`numberOfFrequencyCaps`	`integer`	The number of frequency caps to be collected. Defaults to `1`.