Create Donation with NationBuilder API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

Create Donation 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 Schedule 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 Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Donation action
1. Connect your NationBuilder account
2. Configure Amount In Cents
3. Optional- Select a Author Id
4. Optional- Configure Billing Address 1
5. Optional- Configure Billing Address 2
6. Optional- Configure Billing Address 3
7. Optional- Configure Billing Address City
8. Optional- Configure Billing Address State
9. Optional- Configure Billing Address Zip
10. Optional- Configure Billing Address Country Code
11. Optional- Configure Billing Address Lat
12. Optional- Configure Billing Address Lng
13. Optional- Configure Check Number
14. Optional- Configure Corporate Contribution
15. Select a Donor Id
16. Optional- Configure Is Private
17. Optional- Configure Note
18. Optional- Select a Payment Type Name
19. Optional- Configure Recruiter Name Or Email
20. Optional- Configure Tracking Code Slug
21. Optional- Configure Work Address 1
22. Optional- Configure Work Address 2
23. Optional- Configure Work Address 3
24. Optional- Configure Work Address City
25. Optional- Configure Work Address State
26. Optional- Configure Work Address Zip
27. Optional- Configure Work Address Country Code
28. Optional- Configure Work Address Lat
29. Optional- Configure Work Address Lng
30. Optional- Configure ActBlue Order Number
31. Optional- Select a Fec Type
32. Optional- Configure Cycle
33. Optional- Select a Period
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Donation on NationBuilder

Description:Create a new donation with the provided data. [See the documentation](https://nationbuilder.com/donations_api)

Version:0.0.1

Key:nationbuilder-create-donation

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 {
  ELECTION_CODES,
  FEC_CODES, PAYMENT_CODES,
} from "../../common/constants.mjs";
import nationbuilder from "../../nationbuilder.app.mjs";

export default {
  key: "nationbuilder-create-donation",
  name: "Create Donation",
  version: "0.0.1",
  description: "Create a new donation with the provided data. [See the documentation](https://nationbuilder.com/donations_api)",
  type: "action",
  props: {
    nationbuilder,
    amountInCents: {
      propDefinition: [
        nationbuilder,
        "amountInCents",
      ],
    },
    authorId: {
      propDefinition: [
        nationbuilder,
        "personId",
      ],
      label: "Author Id",
      description: "Id of the person who created the donation.",
      optional: true,
    },
    billingAddress1: {
      propDefinition: [
        nationbuilder,
        "registeredAddress1",
      ],
      label: "Billing Address 1",
      optional: true,
    },
    billingAddress2: {
      propDefinition: [
        nationbuilder,
        "registeredAddress2",
      ],
      label: "Billing Address 2",
      optional: true,
    },
    billingAddress3: {
      propDefinition: [
        nationbuilder,
        "registeredAddress3",
      ],
      label: "Billing Address 3",
      optional: true,
    },
    billingAddressCity: {
      propDefinition: [
        nationbuilder,
        "registeredAddressCity",
      ],
      label: "Billing Address City",
      description: "The city of the billing address.",
      optional: true,
    },
    billingAddressState: {
      propDefinition: [
        nationbuilder,
        "registeredAddressState",
      ],
      label: "Billing Address State",
      description: "The state of the billing address.",
      optional: true,
    },
    billingAddressZip: {
      propDefinition: [
        nationbuilder,
        "registeredAddressZip",
      ],
      label: "Billing Address Zip",
      description: "The zip code of the billing address.",
      optional: true,
    },
    billingAddressCountryCode: {
      propDefinition: [
        nationbuilder,
        "registeredAddressCountryCode",
      ],
      label: "Billing Address Country Code",
      description: "The country code of the billing address (using ISO-3166-1 alpha-2).",
      optional: true,
    },
    billingAddressLat: {
      propDefinition: [
        nationbuilder,
        "registeredAddressLat",
      ],
      label: "Billing Address Lat",
      description: "The latitude of the billing address (using WGS-84).",
      optional: true,
    },
    billingAddressLng: {
      propDefinition: [
        nationbuilder,
        "registeredAddressLng",
      ],
      label: "Billing Address Lng",
      description: "The longitude of the billing address (using WGS-84).",
      optional: true,
    },
    checkNumber: {
      propDefinition: [
        nationbuilder,
        "checkNumber",
      ],
      optional: true,
    },
    corporateContribution: {
      propDefinition: [
        nationbuilder,
        "corporateContribution",
      ],
      optional: true,
    },
    donorId: {
      propDefinition: [
        nationbuilder,
        "personId",
      ],
      label: "Donor Id",
      description: "The person id of the donor.",
    },
    isPrivate: {
      propDefinition: [
        nationbuilder,
        "isPrivate",
      ],
      optional: true,
    },
    note: {
      propDefinition: [
        nationbuilder,
        "note",
      ],
      optional: true,
    },
    paymentTypeName: {
      propDefinition: [
        nationbuilder,
        "paymentTypeName",
      ],
      optional: true,
    },
    recruiterNameOrEmail: {
      propDefinition: [
        nationbuilder,
        "recruiterNameOrEmail",
      ],
      optional: true,
    },
    trackingCodeSlug: {
      propDefinition: [
        nationbuilder,
        "trackingCodeSlug",
      ],
      optional: true,
    },
    workAddress1: {
      propDefinition: [
        nationbuilder,
        "registeredAddress1",
      ],
      label: "Work Address 1",
      optional: true,
    },
    workAddress2: {
      propDefinition: [
        nationbuilder,
        "registeredAddress2",
      ],
      label: "Work Address 2",
      optional: true,
    },
    workAddress3: {
      propDefinition: [
        nationbuilder,
        "registeredAddress3",
      ],
      label: "Work Address 3",
      optional: true,
    },
    workAddressCity: {
      propDefinition: [
        nationbuilder,
        "registeredAddressCity",
      ],
      label: "Work Address City",
      description: "The city of the work address.",
      optional: true,
    },
    workAddressState: {
      propDefinition: [
        nationbuilder,
        "registeredAddressState",
      ],
      label: "Work Address State",
      description: "The state of the work address.",
      optional: true,
    },
    workAddressZip: {
      propDefinition: [
        nationbuilder,
        "registeredAddressZip",
      ],
      label: "Work Address Zip",
      description: "The zip code of the work address.",
      optional: true,
    },
    workAddressCountryCode: {
      propDefinition: [
        nationbuilder,
        "registeredAddressCountryCode",
      ],
      label: "Work Address Country Code",
      description: "The country code of the work address (using ISO-3166-1 alpha-2).",
      optional: true,
    },
    workAddressLat: {
      propDefinition: [
        nationbuilder,
        "registeredAddressLat",
      ],
      label: "Work Address Lat",
      description: "The latitude of the work address (using WGS-84).",
      optional: true,
    },
    workAddressLng: {
      propDefinition: [
        nationbuilder,
        "registeredAddressLng",
      ],
      label: "Work Address Lng",
      description: "The longitude of the work address (using WGS-84).",
      optional: true,
    },
    actblueOrderNumber: {
      propDefinition: [
        nationbuilder,
        "actblueOrderNumber",
      ],
      optional: true,
    },
    fecType: {
      propDefinition: [
        nationbuilder,
        "fecType",
      ],
      optional: true,
    },
    cycle: {
      propDefinition: [
        nationbuilder,
        "cycle",
      ],
      optional: true,
    },
    period: {
      propDefinition: [
        nationbuilder,
        "period",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      nationbuilder,
      amountInCents,
      authorId,
      billingAddress1,
      billingAddress2,
      billingAddress3,
      billingAddressCity,
      billingAddressState,
      billingAddressZip,
      billingAddressCountryCode,
      billingAddressLat,
      billingAddressLng,
      checkNumber,
      corporateContribution,
      donorId,
      isPrivate,
      paymentTypeName,
      recruiterNameOrEmail,
      trackingCodeSlug,
      workAddress1,
      workAddress2,
      workAddress3,
      workAddressCity,
      workAddressState,
      workAddressZip,
      workAddressCountryCode,
      workAddressLat,
      workAddressLng,
      actblueOrderNumber,
      fecType,
      cycle,
      period,
      ...data
    } = this;

    const response = await nationbuilder.createDonation({
      $,
      data: {
        donation: {
          amount_in_cents: amountInCents,
          author_id: authorId,
          billing_address: {
            address1: billingAddress1,
            address2: billingAddress2,
            address3: billingAddress3,
            city: billingAddressCity,
            state: billingAddressState,
            zip: billingAddressZip,
            country_code: billingAddressCountryCode,
            lat: billingAddressLat,
            lng: billingAddressLng,
          },
          check_number: checkNumber,
          corporate_contribution: corporateContribution,
          donor_id: donorId,
          is_private: isPrivate,
          payment_type_name: paymentTypeName,
          payment_type_ngp_code: PAYMENT_CODES[paymentTypeName],
          recruiter_name_or_email: recruiterNameOrEmail,
          tracking_code_slug: trackingCodeSlug,
          work_address: {
            address1: workAddress1,
            address2: workAddress2,
            address3: workAddress3,
            city: workAddressCity,
            state: workAddressState,
            zip: workAddressZip,
            country_code: workAddressCountryCode,
            lat: workAddressLat,
            lng: workAddressLng,
          },
          actblue_order_number: actblueOrderNumber,
          fec_type: fecType,
          fec_type_ngp_code: FEC_CODES[fecType],
          election: {
            cycle,
            period,
            period_ngp_code: ELECTION_CODES[period],
          },
          ...data,
        },
      },
    });

    $.export("$summary", `A new donation with Id: ${response.donation?.id} was successfully created!`);
    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.
Amount In Cents	`amountInCents`	`integer`	Amount of donation in cents.
Author Id	`authorId`	`string`	Select a value from the drop down menu.
Billing Address 1	`billingAddress1`	`string`	First Address Line.
Billing Address 2	`billingAddress2`	`string`	Second Address Line.
Billing Address 3	`billingAddress3`	`string`	Third Address Line.
Billing Address City	`billingAddressCity`	`string`	The city of the billing address.
Billing Address State	`billingAddressState`	`string`	The state of the billing address.
Billing Address Zip	`billingAddressZip`	`string`	The zip code of the billing address.
Billing Address Country Code	`billingAddressCountryCode`	`string`	The country code of the billing address (using ISO-3166-1 alpha-2).
Billing Address Lat	`billingAddressLat`	`string`	The latitude of the billing address (using WGS-84).
Billing Address Lng	`billingAddressLng`	`string`	The longitude of the billing address (using WGS-84).
Check Number	`checkNumber`	`string`	Check/wire/MO number.
Corporate Contribution	`corporateContribution`	`boolean`	True if the donation is a corporate contribution.
Donor Id	`donorId`	`string`	Select a value from the drop down menu.
Is Private	`isPrivate`	`boolean`	False if the donation should be posted publicly on the site.
Note	`note`	`string`	a note for this donation.
Payment Type Name	`paymentTypeName`	`string`	Select a value from the drop down menu:`CashCredit CardCheckMoney OrderEFTIn-KindWire TransferOtherSquareActBlueGoogle PayApple Pay`
Recruiter Name Or Email	`recruiterNameOrEmail`	`string`	Recruiter's name or email address (will also be credited as the fundraiser for this donation).
Tracking Code Slug	`trackingCodeSlug`	`string`	Tracking code for this donation.
Work Address 1	`workAddress1`	`string`	First Address Line.
Work Address 2	`workAddress2`	`string`	Second Address Line.
Work Address 3	`workAddress3`	`string`	Third Address Line.
Work Address City	`workAddressCity`	`string`	The city of the work address.
Work Address State	`workAddressState`	`string`	The state of the work address.
Work Address Zip	`workAddressZip`	`string`	The zip code of the work address.
Work Address Country Code	`workAddressCountryCode`	`string`	The country code of the work address (using ISO-3166-1 alpha-2).
Work Address Lat	`workAddressLat`	`string`	The latitude of the work address (using WGS-84).
Work Address Lng	`workAddressLng`	`string`	The longitude of the work address (using WGS-84).
ActBlue Order Number	`actblueOrderNumber`	`integer`	ActBlue order number.
Fec Type	`fecType`	`string`	Select a value from the drop down menu:`ContributionExempt legal expenseOffsetsDebt owed to committeeInterestLoanLoan from candidateTransferOther`
Cycle	`cycle`	`integer`	Election cycle.
Period	`period`	`string`	Select a value from the drop down menu:`ConventionRecountGeneralPrevious CampaignPrimaryPresidential PrimaryRunoffSpecialUnknownOther`

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