Create Constituent with Bloomerang API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Constituent with the Bloomerang 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 Bloomerang 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 Create Constituent action
1. Connect your Bloomerang account
2. Select a Constituent Type
3. Optional- Select a Status
4. Configure Organization Name
5. Configure First Name
6. Configure Last Name
7. Optional- Configure Middle Name
8. Optional- Select a Title
9. Optional- Select a Suffix
10. Optional- Configure Job Title
11. Optional- Select a Gender
12. Optional- Configure Birthdate
13. Optional- Configure Employer
14. Optional- Configure Website
15. Optional- Configure Facebook
16. Optional- Configure Twitter ID
17. Optional- Configure LinkedIn
18. Optional- Select a Preferred Communication Channel
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#

Create Constituent on Bloomerang

Description:Creates a new constituent in Bloomerang. [See the documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/post_constituent)

Version:0.0.1

Key:bloomerang-create-constituent

View on GitHub

Action Code#

import bloomerang from "../../bloomerang.app.mjs";
import {
  COMMUNICATION_CHANNEL_OPTIONS,
  CONSTITUENT_GENDER_OPTIONS,
  CONSTITUENT_PREFIX_OPTIONS,
  CONSTITUENT_STATUS_OPTIONS,
  CONSTITUENT_SUFFIX_OPTIONS,
  CONSTITUENT_TYPE_OPTIONS,
} from "../../common/constants.mjs";

export default {
  key: "bloomerang-create-constituent",
  name: "Create Constituent",
  description: "Creates a new constituent in Bloomerang. [See the documentation](https://bloomerang.co/product/integrations-data-management/api/rest-api/#/Constituents/post_constituent)",
  version: "0.0.1",
  type: "action",
  props: {
    bloomerang,
    type: {
      type: "string",
      label: "Constituent Type",
      description: "Filter constituents by type",
      options: CONSTITUENT_TYPE_OPTIONS,
      reloadProps: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the constituent",
      options: CONSTITUENT_STATUS_OPTIONS,
      optional: true,
    },
    fullName: {
      type: "string",
      label: "Organization Name",
      description: "The organization's name of the constituent",
      hidden: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the constituent",
      hidden: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the constituent",
      hidden: true,
    },
    middleName: {
      type: "string",
      label: "Middle Name",
      description: "The middle name of the constituent",
      optional: true,
    },
    prefix: {
      type: "string",
      label: "Title",
      description: "The prefix of the constituent",
      options: CONSTITUENT_PREFIX_OPTIONS,
      optional: true,
    },
    suffix: {
      type: "string",
      label: "Suffix",
      description: "The suffix of the constituent",
      options: CONSTITUENT_SUFFIX_OPTIONS,
      optional: true,
    },
    jobTitle: {
      type: "string",
      label: "Job Title",
      description: "The job title of the constituent",
      optional: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "The gender of the constituent",
      options: CONSTITUENT_GENDER_OPTIONS,
      optional: true,
    },
    birthdate: {
      type: "string",
      label: "Birthdate",
      description: "The birth date of the constituent",
      optional: true,
    },
    employer: {
      type: "string",
      label: "Employer",
      description: "The employer of the constituent",
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "An website of the constituent",
      optional: true,
    },
    facebookId: {
      type: "string",
      label: "Facebook",
      description: "The constituent's facebook page",
      optional: true,
    },
    twitterId: {
      type: "string",
      label: "Twitter ID",
      description: "The constituent's twitter ID",
      optional: true,
    },
    linkedInId: {
      type: "string",
      label: "LinkedIn",
      description: "The constituent's linkedIn page",
      optional: true,
    },
    preferredCommunicationChannel: {
      type: "string",
      label: "Preferred Communication Channel",
      description: "The preferred comunication channel of the constituent",
      options: COMMUNICATION_CHANNEL_OPTIONS,
      optional: true,
    },
  },
  async additionalProps(props) {
    const isIndividual = this.type === "Individual";
    props.firstName.hidden = !isIndividual;
    props.lastName.hidden = !isIndividual;
    props.fullName.hidden = isIndividual;
    return {};
  },
  async run({ $ }) {
    const data = {
      Type: this.type,
      Status: this.status,
      Prefix: this.prefix,
      Suffix: this.suffix,
      JobTitle: this.jobTitle,
      Gender: this.gender,
      Birthdate: this.birthdate,
      Employer: this.employer,
      Website: this.website,
      FacebookId: this.facebookId,
      TwitterId: this.twitterId,
      LinkedInId: this.linkedInId,
      PreferredCommunicationChannel: this.preferredCommunicationChannel,
    };
    if (this.type === "Individual") {
      data.FirstName = this.firstName;
      data.LastName = this.lastName;
      data.MiddleName = this.middleName;
    } else {
      data.FullName = this.fullName;
    }

    const response = await this.bloomerang.createConstituent({
      $,
      data,
    });

    $.export("$summary", `Successfully created constituent 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
Bloomerang	`bloomerang`	`app`	This component uses the Bloomerang app.
Constituent Type	`type`	`string`	Select a value from the drop down menu:`IndividualOrganization`
Status	`status`	`string`	Select a value from the drop down menu:`ActiveInactiveDeceased`
Middle Name	`middleName`	`string`	The middle name of the constituent
Title	`prefix`	`string`	Select a value from the drop down menu:`Atty.CaptCmdrCoachColDr.Fr.GenGov.Hon.LtMajMasterMissMr.Mrs.Ms.Mx.PastorPres.Prof.PvtRabbiRep.Rev.Sen.SgtSirSr.`
Suffix	`suffix`	`string`	Select a value from the drop down menu:`DDSEsq.IIIIIIVJr.M.D.Ph.D.Sr.V`
Job Title	`jobTitle`	`string`	The job title of the constituent
Gender	`gender`	`string`	Select a value from the drop down menu:`MaleFemaleOther`
Birthdate	`birthdate`	`string`	The birth date of the constituent
Employer	`employer`	`string`	The employer of the constituent
Website	`website`	`string`	An website of the constituent
Facebook	`facebookId`	`string`	The constituent's facebook page
Twitter ID	`twitterId`	`string`	The constituent's twitter ID
LinkedIn	`linkedInId`	`string`	The constituent's linkedIn page
Preferred Communication Channel	`preferredCommunicationChannel`	`string`	Select a value from the drop down menu:`EmailPhoneText MessageMail`

Action Authentication#

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

About Bloomerang#

Bloomerang Donor Management and Fundraising Software for Nonprofits

More Ways to Connect Bloomerang + Pipedream#

Other Popular Integrations#

Add Interaction with Bloomerang API on New Scheduled Tasks from Pipedream API

Pipedream + Bloomerang

Create Constituent with Bloomerang API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

1
-
24
of
2,500+
apps by most popular