Create Company with Aero Workflow API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Aero Workflow, Pipedream and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Company with the Aero Workflow 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 Aero Workflow 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 Company action
1. Connect your Aero Workflow account
2. Configure Company Name
3. Optional- Configure Default Email Address
4. Optional- Configure Phone
5. Optional- Configure Website
6. Optional- Configure Account Number
7. Optional- Configure Fax
8. Optional- Configure Hourly Billable Rate
9. Optional- Configure Monthly Fixed Fee
10. Optional- Configure Contact First Name
11. Optional- Configure Contact Last Name
12. Optional- Configure Company Address Line 1
13. Optional- Configure Company Line 2
14. Optional- Configure Company Line 3
15. Optional- Configure City (Address)
16. Optional- Configure State (Address)
17. Optional- Configure Postal Code (Address)
18. Optional- Configure Country (Address)
19. Optional- Configure Notes
20. Optional- Configure Is Lead
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 Company on Aero Workflow

Description:Creates a company [See the docs here](https://api.aeroworkflow.com/swagger/index.html)

Version:0.0.2

Key:aero_workflow-create-company

View on GitHub

Aero Workflow Overview#

The Aero Workflow API enables the automation of task management and workflow optimization for professional service firms. Using Pipedream, you can harness this API to create powerful automations that streamline the tasks and procedures within your business. This can significantly reduce manual input, error rates, and increase overall efficiency.

Action Code#

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

export default {
  key: "aero_workflow-create-company",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  name: "Create Company",
  description: "Creates a company [See the docs here](https://api.aeroworkflow.com/swagger/index.html)",
  props: {
    app,
    companyName: {
      type: "string",
      label: "Company Name",
      description: "Company name",
    },
    defaultEmailAddress: {
      type: "string",
      label: "Default Email Address",
      description: "Default email address",
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Phone",
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "Website",
      optional: true,
    },
    accountNumber: {
      type: "string",
      label: "Account Number",
      description: "Account number",
      optional: true,
    },
    fax: {
      type: "string",
      label: "Fax",
      description: "Fax",
      optional: true,
    },
    hourlyBillableRate: {
      type: "integer",
      label: "Hourly Billable Rate",
      description: "Hourly billable rate",
      optional: true,
    },
    monthlyFixedFee: {
      type: "integer",
      label: "Monthly Fixed Fee",
      description: "Monthly fixed fee",
      optional: true,
    },
    contactFirstName: {
      type: "string",
      label: "Contact First Name",
      description: "Contact first name",
      optional: true,
    },
    contactLastName: {
      type: "string",
      label: "Contact Last Name",
      description: "Contact last name",
      optional: true,
    },
    addressLine1: {
      type: "string",
      label: "Company Address Line 1",
      description: "Address line 1",
      optional: true,
    },
    addressLine2: {
      type: "string",
      label: "Company Line 2",
      description: "Address line 2",
      optional: true,
    },
    addressLine3: {
      type: "string",
      label: "Company Line 3",
      description: "Address line 3",
      optional: true,
    },
    addressCity: {
      type: "string",
      label: "City (Address)",
      description: "Address city",
      optional: true,
    },
    addressState: {
      type: "string",
      label: "State (Address)",
      description: "Address state",
      optional: true,
    },
    addressPostalCode: {
      type: "string",
      label: "Postal Code (Address)",
      description: "Address postal code",
      optional: true,
    },
    addressCountry: {
      type: "string",
      label: "Country (Address)",
      description: "Address country",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Company notes",
      optional: true,
    },
    isLead: {
      type: "boolean",
      label: "Is Lead",
      description: "Set true if it is a lead",
      optional: true,
    },
  },
  async run ({ $ }) {
    const pairs = {
      companyName: "name",
    };
    const data = utils.extractProps(this, pairs);
    const resp = await this.app.createCompany({
      $,
      data,
    });
    $.export("$summary", `The company(ID: ${resp.id}) has been created successfully.`);
    return resp;
  },
};

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
Aero Workflow	`app`	`app`	This component uses the Aero Workflow app.
Company Name	`companyName`	`string`	Company name
Default Email Address	`defaultEmailAddress`	`string`	Default email address
Phone	`phone`	`string`	Phone
Website	`website`	`string`	Website
Account Number	`accountNumber`	`string`	Account number
Fax	`fax`	`string`	Fax
Hourly Billable Rate	`hourlyBillableRate`	`integer`	Hourly billable rate
Monthly Fixed Fee	`monthlyFixedFee`	`integer`	Monthly fixed fee
Contact First Name	`contactFirstName`	`string`	Contact first name
Contact Last Name	`contactLastName`	`string`	Contact last name
Company Address Line 1	`addressLine1`	`string`	Address line 1
Company Line 2	`addressLine2`	`string`	Address line 2
Company Line 3	`addressLine3`	`string`	Address line 3
City (Address)	`addressCity`	`string`	Address city
State (Address)	`addressState`	`string`	Address state
Postal Code (Address)	`addressPostalCode`	`string`	Address postal code
Country (Address)	`addressCountry`	`string`	Address country
Notes	`notes`	`string`	Company notes
Is Lead	`isLead`	`boolean`	Set true if it is a lead

Action Authentication#

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

To get your API Key and Account Number, navigate to Account Settings > Account Profile.

If you've already created an API Key it will be listed on this screen.
If there is no API Key listed, click the Generate new API Key button.
The Account Number (also sometimes called "Account ID") is listed below the API Key

Try it

Create Contact with Aero Workflow API on New Scheduled Tasks from Pipedream API

Pipedream + Aero Workflow

Try it

Create Email Aero with Aero Workflow API on New Scheduled Tasks from Pipedream API

Pipedream + Aero Workflow

Try it

Create Task with Aero Workflow API on New Scheduled Tasks from Pipedream API

Pipedream + Aero Workflow

Try it

Create Vault Entry with Aero Workflow API on New Scheduled Tasks from Pipedream API

Pipedream + Aero Workflow

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

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

New Company Created Event from the Aero Workflow API

Emit new events when a new company is created. See the docs

Try it