Push Person with NationBuilder API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for NationBuilder, Typeform and 2,400+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Push Person with the NationBuilder 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 NationBuilder 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 Push Person action
1. Connect your NationBuilder account
2. Optional- Configure Civicrm Id
3. Optional- Configure County File Id
4. Optional- Configure DW Id
5. Optional- Configure External Id
6. Optional- Configure Email
7. Optional- Configure Facebook Username
8. Optional- Configure NGP Id
9. Optional- Configure Salesforce Id
10. Optional- Configure Twitter Login
11. Optional- Configure Van Id
12. Optional- Configure First Name
13. Optional- Configure Last Name
14. Optional- Configure Phone
15. Optional- Select a Sex
16. Optional- Select a Signup Type
17. Optional- Configure Employer
18. Optional- Configure Party
19. Optional- Configure Registered Address 1
20. Optional- Configure Registered Address 2
21. Optional- Configure Registered Address 3
22. Optional- Configure Registered Address City
23. Optional- Configure Registered Address State
24. Optional- Configure Registered Address Zip
25. Optional- Configure Registered Address Country Code
26. Optional- Configure Registered Address Lat
27. Optional- Configure Registered Address Lng
28. Optional- Configure Tags
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#

Push Person on NationBuilder

Description:This endpoint attempts to match the input person resource to a person already in the nation. If a match is found, the matched person is updated and a 200 status code is returned. If a match is not found, a new person is created and a 201 status code is returned. Matches are found by including one of the following IDs in the request: `civicrm_id`, `county_file_id`, `dw_id`, `external_id`, `email`, `facebook_username`, `ngp_id`, `salesforce_id`, `twitter_login`, `van_id`. [See the documentation](https://nationbuilder.com/people_api)

Version:0.0.1

Key:nationbuilder-push-person

View on GitHub

NationBuilder Overview#

NationBuilder is a comprehensive platform for community organizing, offering tools for website creation, donor management, and communication with the community. The NationBuilder API unlocks potent opportunities for automation and data management. On Pipedream, you can leverage this API to streamline interactions between NationBuilder and other services, automate contacts synchronization, trigger communications based on user activities, and more, all while enjoying the benefits of serverless workflows.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import nationbuilder from "../../nationbuilder.app.mjs";

export default {
  key: "nationbuilder-push-person",
  name: "Push Person",
  version: "0.0.1",
  description: "This endpoint attempts to match the input person resource to a person already in the nation. If a match is found, the matched person is updated and a 200 status code is returned. If a match is not found, a new person is created and a 201 status code is returned. Matches are found by including one of the following IDs in the request: `civicrm_id`,  `county_file_id`,  `dw_id`,  `external_id`,  `email`,  `facebook_username`,  `ngp_id`,  `salesforce_id`,  `twitter_login`, `van_id`. [See the documentation](https://nationbuilder.com/people_api)",
  type: "action",
  props: {
    nationbuilder,
    civicrmId: {
      type: "string",
      label: "Civicrm Id",
      description: "Civicrm id of the person to match.",
      optional: true,
    },
    countyFileId: {
      type: "string",
      label: "County File Id",
      description: "Count File Id of the person to match.",
      optional: true,
    },
    dwId: {
      type: "string",
      label: "DW Id",
      description: "DW Id of the person to match.",
      optional: true,
    },
    externalId: {
      type: "string",
      label: "External Id",
      description: "External Id of the person to match.",
      optional: true,
    },
    email: {
      propDefinition: [
        nationbuilder,
        "email",
      ],
      optional: true,
    },
    facebookUsername: {
      propDefinition: [
        nationbuilder,
        "facebookUsername",
      ],
      optional: true,
    },
    ngpId: {
      propDefinition: [
        nationbuilder,
        "ngpId",
      ],
      optional: true,
    },
    salesforceId: {
      type: "string",
      label: "Salesforce Id",
      description: "Salesforce Id of the person to match.",
      optional: true,
    },
    twitterLogin: {
      propDefinition: [
        nationbuilder,
        "twitterLogin",
      ],
      optional: true,
    },
    vanId: {
      type: "string",
      label: "Van Id",
      description: "Van Id of the person to match.",
      optional: true,
    },
    firstName: {
      propDefinition: [
        nationbuilder,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        nationbuilder,
        "lastName",
      ],
      optional: true,
    },
    phone: {
      propDefinition: [
        nationbuilder,
        "phone",
      ],
      optional: true,
    },
    sex: {
      propDefinition: [
        nationbuilder,
        "sex",
      ],
      optional: true,
    },
    signupType: {
      propDefinition: [
        nationbuilder,
        "signupType",
      ],
      optional: true,
    },
    employer: {
      propDefinition: [
        nationbuilder,
        "employer",
      ],
      optional: true,
    },
    party: {
      propDefinition: [
        nationbuilder,
        "party",
      ],
      optional: true,
    },
    registeredAddress1: {
      propDefinition: [
        nationbuilder,
        "registeredAddress1",
      ],
      optional: true,
    },
    registeredAddress2: {
      propDefinition: [
        nationbuilder,
        "registeredAddress2",
      ],
      optional: true,
    },
    registeredAddress3: {
      propDefinition: [
        nationbuilder,
        "registeredAddress3",
      ],
      optional: true,
    },
    registeredAddressCity: {
      propDefinition: [
        nationbuilder,
        "registeredAddressCity",
      ],
      optional: true,
    },
    registeredAddressState: {
      propDefinition: [
        nationbuilder,
        "registeredAddressState",
      ],
      optional: true,
    },
    registeredAddressZip: {
      propDefinition: [
        nationbuilder,
        "registeredAddressZip",
      ],
      optional: true,
    },
    registeredAddressCountryCode: {
      propDefinition: [
        nationbuilder,
        "registeredAddressCountryCode",
      ],
      optional: true,
    },
    registeredAddressLat: {
      propDefinition: [
        nationbuilder,
        "registeredAddressLat",
      ],
      optional: true,
    },
    registeredAddressLng: {
      propDefinition: [
        nationbuilder,
        "registeredAddressLng",
      ],
      optional: true,
    },
    tags: {
      propDefinition: [
        nationbuilder,
        "tags",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      nationbuilder,
      civicrmId,
      countyFileId,
      dwId,
      externalId,
      email,
      facebookUsername,
      ngpId,
      salesforceId,
      twitterLogin,
      vanId,
      firstName,
      lastName,
      phone,
      signupType,
      registeredAddress1,
      registeredAddress2,
      registeredAddress3,
      registeredAddressCity,
      registeredAddressState,
      registeredAddressZip,
      registeredAddressCountryCode,
      registeredAddressLat,
      registeredAddressLng,
      ...data
    } = this;

    if (!firstName && !email && !phone) {
      throw new ConfigurationError("You must supply at least a first and last name, an email address, or a phone number.");
    }

    const response = await nationbuilder.pushPerson({
      $,
      data: {
        person: {
          civicrm_id: civicrmId,
          county_file_id: countyFileId,
          dw_id: dwId,
          external_id: externalId,
          facebook_username: facebookUsername,
          ngp_id: ngpId,
          salesforce_id: salesforceId,
          twitter_login: twitterLogin,
          van_id: vanId,
          first_name: firstName,
          last_name: lastName,
          email,
          phone,
          signup_type: signupType,
          registered_address: {
            address1: registeredAddress1,
            address2: registeredAddress2,
            address3: registeredAddress3,
            city: registeredAddressCity,
            state: registeredAddressState,
            zip: registeredAddressZip,
            country_code: registeredAddressCountryCode,
            lat: registeredAddressLat,
            lng: registeredAddressLng,
          },
          ...data,
        },
      },
    });

    $.export("$summary", `The person with Id: ${response.person?.id} was successfully pushed!`);
    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
NationBuilder	`nationbuilder`	`app`	This component uses the NationBuilder app.
Civicrm Id	`civicrmId`	`string`	Civicrm id of the person to match.
County File Id	`countyFileId`	`string`	Count File Id of the person to match.
DW Id	`dwId`	`string`	DW Id of the person to match.
External Id	`externalId`	`string`	External Id of the person to match.
Email	`email`	`string`	Email address for this person.
Facebook Username	`facebookUsername`	`string`	The person's Facebook username.
NGP Id	`ngpId`	`string`	NGP Id of the person to match.
Salesforce Id	`salesforceId`	`string`	Salesforce Id of the person to match.
Twitter Login	`twitterLogin`	`string`	The person's Twitter login name.
Van Id	`vanId`	`string`	Van Id of the person to match.
First Name	`firstName`	`string`	The person's first name and middle names.
Last Name	`lastName`	`string`	The person's last name.
Phone	`phone`	`string`	This person's home phone number.
Sex	`sex`	`string`	Select a value from the drop down menu:`FMO`
Signup Type	`signupType`	`string`	Select a value from the drop down menu:`{ "label": "Person", "value": "0" }{ "label": "Organization", "value": "1" }`
Employer	`employer`	`string`	The name of the company for which this person works.
Party	`party`	`string`	A one-letter code representing provincial parties for nations.
Registered Address 1	`registeredAddress1`	`string`	First Address Line.
Registered Address 2	`registeredAddress2`	`string`	Second Address Line.
Registered Address 3	`registeredAddress3`	`string`	Third Address Line.
Registered Address City	`registeredAddressCity`	`string`	The city of the registered address.
Registered Address State	`registeredAddressState`	`string`	The state of the registered address.
Registered Address Zip	`registeredAddressZip`	`string`	The zip code of the registered address.
Registered Address Country Code	`registeredAddressCountryCode`	`string`	The country code of the registered address (using ISO-3166-1 alpha-2).
Registered Address Lat	`registeredAddressLat`	`string`	The latitude of the registered address (using WGS-84).
Registered Address Lng	`registeredAddressLng`	`string`	The longitude of the registered address (using WGS-84).
Tags	`tags`	`string[]`	The tags assigned to this person.

Action Authentication#

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

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

default