Update Donation with NationBuilder API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

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

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

Action#

Update Donation on NationBuilder

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

Version:0.0.1

Key:nationbuilder-update-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-update-donation",
  name: "Update Donation",
  version: "0.0.1",
  description: "Update a specific donation with the provided data. [See the documentation](https://nationbuilder.com/donations_api)",
  type: "action",
  props: {
    nationbuilder,
    donationId: {
      propDefinition: [
        nationbuilder,
        "donationId",
      ],
    },
    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.",
      optional: true,
    },
    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,
      donationId,
      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.updateDonation({
      $,
      donationId,
      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", `The donation with Id: ${donationId} was successfully updated!`);
    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.
Donation Id	`donationId`	`string`	Select a value from the drop down menu.
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

About NationBuilder#

Human-centric technology for your nonprofit, cause, campaign and movement.

More Ways to Connect NationBuilder + Pipedream#

Other Popular Integrations#

Create Donation with NationBuilder API on New Scheduled Tasks from Pipedream API

Pipedream + NationBuilder

Try it

Add Tags with NationBuilder API on New Scheduled Tasks from Pipedream API

Pipedream + NationBuilder

Try it

Search Person with NationBuilder API on New Scheduled Tasks from Pipedream API

Pipedream + NationBuilder

Try it

Create Membership with NationBuilder API on New Scheduled Tasks from Pipedream API

Pipedream + NationBuilder

Try it

Create Person with NationBuilder API on New Scheduled Tasks from Pipedream API

Pipedream + NationBuilder

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it