Create Event with Add to Calendar PRO API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Add to Calendar PRO, Pipedream and 2,700+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Event with the Add to Calendar PRO 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 Add to Calendar PRO 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 Add to Calendar PRO account
2. Optional- Select a Group Pro Key
3. Optional- Configure New Event Group Name
4. Optional- Configure Title Event Series
5. Optional- Configure Simplified Recurrence
6. Optional- Configure Recurrence
7. Optional- Select a Recurrence Simple Type
8. Optional- Configure Recurrence Interval
9. Optional- Configure Recurrence By Day
10. Optional- Configure Recurrence By Month
11. Optional- Configure Recurrence By Month Day
12. Optional- Configure Recurrence Count
13. Optional- Configure Recurrence Week Start
14. Optional- Configure iCal File Name
15. Optional- Configure RSVP
16. Optional- Configure Event Distribution
17. Optional- Configure Hide Button
18. Optional- Configure Call to Action
19. Optional- Select a Style ID
20. Optional- Select a Landing Page Template ID
21. Optional- Select a RSVP Template ID
22. Optional- Select a CTA Template ID
23. Configure Number of Dates
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 Add to Calendar PRO

Description:Create an event in a group. [See the documentation](https://docs.add-to-calendar-pro.com/api/events#add-an-event)

Version:0.0.2

Key:add_to_calendar_pro-create-event

View on GitHub

Action Code#

import addToCalendarPro from "../../add_to_calendar_pro.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "add_to_calendar_pro-create-event",
  name: "Create Event",
  description: "Create an event in a group. [See the documentation](https://docs.add-to-calendar-pro.com/api/events#add-an-event)",
  version: "0.0.2",
  type: "action",
  props: {
    addToCalendarPro,
    groupProKey: {
      propDefinition: [
        addToCalendarPro,
        "groupProKey",
      ],
      description: "The pro key of the group to add the event to. Either this or newEventGroupName is required.",
      optional: true,
    },
    newEventGroupName: {
      type: "string",
      label: "New Event Group Name",
      description: "Create a new group for the event with the name provided. Either this or groupProKey is required.",
      optional: true,
    },
    titleEventSeries: {
      propDefinition: [
        addToCalendarPro,
        "titleEventSeries",
      ],
    },
    simplifiedRecurrence: {
      propDefinition: [
        addToCalendarPro,
        "simplifiedRecurrence",
      ],
    },
    recurrence: {
      propDefinition: [
        addToCalendarPro,
        "recurrence",
      ],
    },
    recurrenceSimpleType: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceSimpleType",
      ],
    },
    recurrenceInterval: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceInterval",
      ],
    },
    recurrenceByDay: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceByDay",
      ],
    },
    recurrenceByMonth: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceByMonth",
      ],
    },
    recurrenceByMonthDay: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceByMonthDay",
      ],
    },
    recurrenceCount: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceCount",
      ],
    },
    recurrenceWeekStart: {
      propDefinition: [
        addToCalendarPro,
        "recurrenceWeekStart",
      ],
    },
    iCalFileName: {
      propDefinition: [
        addToCalendarPro,
        "iCalFileName",
      ],
    },
    rsvp: {
      propDefinition: [
        addToCalendarPro,
        "rsvp",
      ],
    },
    distribution: {
      propDefinition: [
        addToCalendarPro,
        "distribution",
      ],
    },
    hideButton: {
      propDefinition: [
        addToCalendarPro,
        "hideButton",
      ],
    },
    cta: {
      propDefinition: [
        addToCalendarPro,
        "cta",
      ],
    },
    styleId: {
      propDefinition: [
        addToCalendarPro,
        "styleId",
      ],
    },
    landingPageTemplateId: {
      propDefinition: [
        addToCalendarPro,
        "landingPageTemplateId",
      ],
      optional: true,
    },
    rsvpTemplateId: {
      propDefinition: [
        addToCalendarPro,
        "rsvpTemplateId",
      ],
      optional: true,
    },
    ctaTemplateId: {
      propDefinition: [
        addToCalendarPro,
        "ctaTemplateId",
      ],
      optional: true,
    },
    numberOfDates: {
      type: "integer",
      label: "Number of Dates",
      description: "The number of dates to create for the event",
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    if (!this.numberOfDates) {
      return props;
    }
    for (let i = 0; i < this.numberOfDates; i++) {
      props[`name${i}`] = {
        type: "string",
        label: `Title of Date ${i + 1}`,
        description: `The title of Date ${i + 1}`,
      };
      props[`startDate${i}`] = {
        type: "string",
        label: `Start Date of Date ${i + 1}`,
        description: `The start date of Date ${i + 1} in format YYYY-MM-DD`,
      };
      props[`startTime${i}`] = {
        type: "string",
        label: `Start Time of Date ${i + 1}`,
        description: `The start time of Date ${i + 1} in format HH:MM`,
        optional: true,
      };
      props[`endDate${i}`] = {
        type: "string",
        label: `End Date of Date ${i + 1}`,
        description: `The end date of Date ${i + 1} in format YYYY-MM-DD`,
        optional: true,
      };
      props[`endTime${i}`] = {
        type: "string",
        label: `End Time of Date ${i + 1}`,
        description: `The end time of Date ${i + 1} in format HH:MM`,
        optional: true,
      };
      props[`timeZone${i}`] = {
        type: "string",
        label: `Time Zone of Date ${i + 1}`,
        description: `The time zone of Date ${i + 1}. Example: "America/Los_Angeles"`,
        optional: true,
      };
      props[`description${i}`] = {
        type: "string",
        label: `Description of Date ${i + 1}`,
        description: `The description of Date ${i + 1}`,
        optional: true,
      };
      props[`location${i}`] = {
        type: "string",
        label: `Location of Date ${i + 1}`,
        description: `The location of Date ${i + 1}`,
        optional: true,
      };
      props[`availability${i}`] = {
        type: "string",
        label: `Availability of Date ${i + 1}`,
        description: `The availability of Date ${i + 1}`,
        options: [
          "free",
          "busy",
        ],
        optional: true,
      };
      props[`organizerName${i}`] = {
        type: "string",
        label: `Organizer Name of Date ${i + 1}`,
        description: `The organizer name of Date ${i + 1}`,
        optional: true,
      };
      props[`organizerEmail${i}`] = {
        type: "string",
        label: `Organizer Email of Date ${i + 1}`,
        description: `The organizer email of Date ${i + 1}`,
        optional: true,
      };
      props[`attendeeName${i}`] = {
        type: "string",
        label: `Attendee Name of Date ${i + 1}`,
        description: `The attendee name of Date ${i + 1}`,
        optional: true,
      };
      props[`attendeeEmail${i}`] = {
        type: "string",
        label: `Attendee Email of Date ${i + 1}`,
        description: `The attendee email of Date ${i + 1}`,
        optional: true,
      };
    }
    return props;
  },
  async run({ $ }) {
    if (!this.groupProKey && !this.newEventGroupName) {
      throw new ConfigurationError("Either `groupProKey` or `newEventGroupName` is required.");
    }
    if (this.groupProKey && this.newEventGroupName) {
      throw new ConfigurationError("Only one of `groupProKey` or `newEventGroupName` can be provided.");
    }
    const dates = [];
    for (let i = 0; i < this.numberOfDates; i++) {
      dates.push({
        name: this[`name${i}`],
        startDate: this[`startDate${i}`],
        startTime: this[`startTime${i}`],
        endDate: this[`endDate${i}`],
        endTime: this[`endTime${i}`],
        timeZone: this[`timeZone${i}`],
        description: this[`description${i}`],
        location: this[`location${i}`],
        availability: this[`availability${i}`],
        organizerName: this[`organizerName${i}`],
        organizerEmail: this[`organizerEmail${i}`],
        attendeeName: this[`attendeeName${i}`],
        attendeeEmail: this[`attendeeEmail${i}`],
      });
    }
    const event = await this.addToCalendarPro.createEvent({
      $,
      data: {
        event_group: this.groupProKey,
        new_event_group_name: this.newEventGroupName,
        dates,
        title_event_series: this.titleEventSeries,
        simplified_recurrence: this.simplifiedRecurrence,
        recurrence: this.recurrence,
        recurrence_simple_type: this.recurrenceSimpleType,
        recurrence_interval: this.recurrenceInterval,
        recurrence_byDay: this.recurrenceByDay,
        recurrence_byMonth: this.recurrenceByMonth,
        recurrence_byMonthDay: this.recurrenceByMonthDay,
        recurrence_count: this.recurrenceCount,
        recurrence_weekstart: this.recurrenceWeekStart,
        iCalFileName: this.iCalFileName,
        rsvp: this.rsvp,
        rsvp_block: this.rsvpTemplateId,
        distribution: this.distribution,
        hideButton: this.hideButton,
        cta: this.cta,
        cta_block: this.ctaTemplateId,
        layout: this.styleId,
        landingpage: this.landingPageTemplateId,
      },
    });
    $.export("$summary", "Successfully created event.");
    return event;
  },
};

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
Add to Calendar PRO	`addToCalendarPro`	`app`	This component uses the Add to Calendar PRO app.
Group Pro Key	`groupProKey`	`string`	Select a value from the drop down menu.
New Event Group Name	`newEventGroupName`	`string`	Create a new group for the event with the name provided. Either this or groupProKey is required.
Title Event Series	`titleEventSeries`	`string`	The title of the event series
Simplified Recurrence	`simplifiedRecurrence`	`boolean`	Set false, if you go for the "recurrence" field, which takes an RRULE; and true if you use the other recurrence fields
Recurrence	`recurrence`	`string`	An RRULE. Use in combination with "Simplified Recurrence" being set to false.
Recurrence Simple Type	`recurrenceSimpleType`	`string`	Select a value from the drop down menu:`dailyweeklymonthlyyearly`
Recurrence Interval	`recurrenceInterval`	`integer`	The interval of the recurrence
Recurrence By Day	`recurrenceByDay`	`string`	Example: `2MO,TU` for the second Monday and each Tuesday
Recurrence By Month	`recurrenceByMonth`	`string`	Example: `1,2,12` for Jan, Feb, and Dec
Recurrence By Month Day	`recurrenceByMonthDay`	`string`	Example: `3,23` for the 3rd and 23rd day of the month
Recurrence Count	`recurrenceCount`	`integer`	The count of the recurrence
Recurrence Week Start	`recurrenceWeekStart`	`string`	The week start of the recurrence. Example: `MO` for Monday
iCal File Name	`iCalFileName`	`string`	Overriding the ics file name
RSVP	`rsvp`	`boolean`	Whether the event is an RSVP event
Event Distribution	`distribution`	`boolean`	Whether the event is distributed to all group members
Hide Button	`hideButton`	`boolean`	Whether the Add to Calendar button is hidden
Call to Action	`cta`	`boolean`	Whether the event has a call to action
Style ID	`styleId`	`integer`	Select a value from the drop down menu.
Landing Page Template ID	`landingPageTemplateId`	`integer`	Select a value from the drop down menu.
RSVP Template ID	`rsvpTemplateId`	`integer`	Select a value from the drop down menu.
CTA Template ID	`ctaTemplateId`	`integer`	Select a value from the drop down menu.
Number of Dates	`numberOfDates`	`integer`	The number of dates to create for the event

Action Authentication#

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

About Add to Calendar PRO#

The fair Event Marketing and Sharing Tool

More Ways to Connect Add to Calendar PRO + Pipedream#

Other Popular Integrations#

Create Landing Page Template with Add to Calendar PRO API on New Scheduled Tasks from Pipedream API

Pipedream + Add to Calendar PRO

Create Event with Add to Calendar PRO API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Add to Calendar PRO, Pipedream and 2,700+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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