Create Event with Agiliron API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Event with the Agiliron 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 Agiliron 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 Event action
1. Connect your Agiliron account
2. Configure Subject
3. Configure Start Date
4. Configure Start Time
5. Optional- Configure Duration in Hours
6. Optional- Configure Duration in Minutes
7. Optional- Select a Recurring Events
8. Optional- Configure Repeat Until
9. Optional- Configure Account Name
10. Optional- Select a Contact Name
11. Optional- Select a Send Reminder
12. Optional- Configure Reminder Days
13. Optional- Configure Reminder Hours
14. Optional- Configure Reminder Minutes
15. Optional- Select a Status
16. Optional- Select a Send Notification
17. Optional- Select a Activity Type
18. Optional- Configure Location
19. Optional- Configure Description
20. Optional- Configure Custom Fields
21. Optional- Select a Related To Type
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 Event on Agiliron

Description:Creates a new event within Agiliron. [See the documentation](https://api.agiliron.com/docs/add-event-2)

Version:0.0.1

Key:agiliron-create-event

View on GitHub

Action Code#

import agiliron from "../../agiliron.app.mjs";
import constants from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "agiliron-create-event",
  name: "Create Event",
  description: "Creates a new event within Agiliron. [See the documentation](https://api.agiliron.com/docs/add-event-2)",
  version: "0.0.1",
  type: "action",
  props: {
    agiliron,
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the event",
    },
    startdate: {
      type: "string",
      label: "Start Date",
      description: "The start date of the event (format: MM-DD-YYYY)",
    },
    starttime: {
      type: "string",
      label: "Start Time",
      description: "The start time of the event (format: HH:MM)",
    },
    durationInHours: {
      type: "string",
      label: "Duration in Hours",
      description: "The duration of the event in hours",
      optional: true,
    },
    durationInMinutes: {
      type: "string",
      label: "Duration in Minutes",
      description: "The duration of the event in minutes",
      optional: true,
    },
    recurringEvents: {
      type: "string",
      label: "Recurring Events",
      description: "Details of the recurring events",
      options: constants.RECURRING_EVENT_OPTIONS,
      optional: true,
    },
    repeatUntil: {
      type: "string",
      label: "Repeat Until",
      description: "The end date of the recurring events (format: MM-DD-YYYY)",
      optional: true,
    },
    accountName: {
      type: "string",
      label: "Account Name",
      description: "The name of the account related to the event",
      optional: true,
    },
    contactName: {
      propDefinition: [
        agiliron,
        "contactName",
      ],
      optional: true,
    },
    sendReminder: {
      type: "string",
      label: "Send Reminder",
      description: "Whether to send a reminder for the event",
      options: constants.BOOL_OPTIONS,
      optional: true,
    },
    reminderDays: {
      type: "string",
      label: "Reminder Days",
      description: "Number of days before the event to send a reminder",
      optional: true,
    },
    reminderHours: {
      type: "string",
      label: "Reminder Hours",
      description: "Number of hours before the event to send a reminder",
      optional: true,
    },
    reminderMinutes: {
      type: "string",
      label: "Reminder Minutes",
      description: "Number of minutes before the event to send a reminder",
      optional: true,
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the event",
      options: constants.STATUS_OPTIONS,
      optional: true,
    },
    sendNotification: {
      type: "string",
      label: "Send Notification",
      description: "Whether to send a notification for the event",
      options: constants.BOOL_OPTIONS,
      optional: true,
    },
    activityType: {
      type: "string",
      label: "Activity Type",
      description: "The type of activity for the event",
      options: constants.ACTIVITY_TYPE_OPTIONS,
      optional: true,
    },
    location: {
      type: "string",
      label: "Location",
      description: "The location of the event",
      optional: true,
    },
    description: {
      type: "string",
      label: "Description",
      description: "The description of the event",
      optional: true,
    },
    customFields: {
      propDefinition: [
        agiliron,
        "customFields",
      ],
      optional: true,
    },
    relatedToType: {
      type: "string",
      label: "Related To Type",
      description: "The type of the entity related to the event",
      options: constants.RELATED_TO_TYPE_OPTIONS,
      optional: true,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.relatedToType) {
      props.relatedToValue = {
        type: "string",
        label: "Related To Value",
        description: "The value of the entity related to the event",
        options: async ({ page }) => {
          return this.agiliron.prepareItems({
            type: this.relatedToType,
            page: page + 1,
          });
        },
        optional: true,
      };
    }
    return props;
  },
  async run({ $ }) {
    const parsedCustomFields = parseObject(this.customFields);
    const customFields = parsedCustomFields && Object.keys(parsedCustomFields).map((key) => ({
      Name: key,
      value: parsedCustomFields[key],
    }));

    const event = {
      Subject: this.subject,
      StartDate: this.startdate,
      StartTime: this.starttime,
      DurationInHours: this.durationInHours,
      DurationInMinutes: this.durationInMinutes,
      RecurringEvents: this.recurringEvents,
      RepeatUntil: this.repeatUntil
        ? this.repeatUntil
        : this.startdate,
      AccountName: this.accountName,
      ContactName: this.contactName,
      RelatedToType: this.relatedToType,
      RelatedToValue: this.relatedToValue,
      SendReminder: this.sendReminder,
      ReminderDays: this.reminderDays,
      ReminderHours: this.reminderHours,
      ReminderMinutes: this.reminderMinutes,
      Status: this.status,
      SendNotification: this.sendNotification,
      ActivityType: this.activityType,
      Location: this.location,
      Description: this.description,
      EventCustomFields: {
        CustomField: customFields,
      },
    };

    const response = await this.agiliron.addEvent({
      $,
      data: {
        Events: {
          Event: event,
        },
      },
    });
    $.export("$summary", `Successfully created event with Id: ${response?.MCM?.parameters?.results?.message?.success_message?.event_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
Agiliron	`agiliron`	`app`	This component uses the Agiliron app.
Subject	`subject`	`string`	The subject of the event
Start Date	`startdate`	`string`	The start date of the event (format: MM-DD-YYYY)
Start Time	`starttime`	`string`	The start time of the event (format: HH:MM)
Duration in Hours	`durationInHours`	`string`	The duration of the event in hours
Duration in Minutes	`durationInMinutes`	`string`	The duration of the event in minutes
Recurring Events	`recurringEvents`	`string`	Select a value from the drop down menu:`--None--DailyWeeklyMonthlyYearly`
Repeat Until	`repeatUntil`	`string`	The end date of the recurring events (format: MM-DD-YYYY)
Account Name	`accountName`	`string`	The name of the account related to the event
Contact Name	`contactName`	`string`	Select a value from the drop down menu.
Send Reminder	`sendReminder`	`string`	Select a value from the drop down menu:`YesNo`
Reminder Days	`reminderDays`	`string`	Number of days before the event to send a reminder
Reminder Hours	`reminderHours`	`string`	Number of hours before the event to send a reminder
Reminder Minutes	`reminderMinutes`	`string`	Number of minutes before the event to send a reminder
Status	`status`	`string`	Select a value from the drop down menu:`PlannedHeldNot Held`
Send Notification	`sendNotification`	`string`	Select a value from the drop down menu:`YesNo`
Activity Type	`activityType`	`string`	Select a value from the drop down menu:`CallMeeting`
Location	`location`	`string`	The location of the event
Description	`description`	`string`	The description of the event
Custom Fields	`customFields`	`object`	An object of custom fields for the lead. Format: {customFieldName01: "Value 01"}
Related To Type	`relatedToType`	`string`	Select a value from the drop down menu:`LeadsAccountsPotentialsQuotesPurchase OrderSales OrderInvoice`

Action Authentication#

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

About Agiliron#

Inventory Management & Multi-Channel Retail POS Software.

More Ways to Connect Agiliron + Pipedream#

Other Popular Integrations#

Create Contact with Agiliron API on New Scheduled Tasks from Pipedream API

Pipedream + Agiliron

Create Event with Agiliron API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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