Execute Task with Airplane API on Weekly schedule from Schedule API

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

Trigger workflow on

Weekly schedule from the Schedule API

Next, do this

Execute Task with the Airplane 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 Schedule trigger and Airplane action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Weekly schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Execute Task action
1. Connect your Airplane account
2. Optional- Configure Task ID
3. Optional- Configure Slug
4. Optional- Configure Parameter Values
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#

Weekly schedule on Schedule

Description:Trigger your workflow on one or more days each week at a specific time (with timezone support).

Version:0.0.1

Key:schedule-weekly

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

import schedule from "../../schedule.app.mjs";

export default {
  name: "Weekly schedule",
  version: "0.0.1",
  key: "schedule-weekly",
  type: "source",
  description: "Trigger your workflow on one or more days each week at a specific time (with timezone support).",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 10 * * 1",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Execute Task on Airplane

Description:Execute a task with a set of parameter values and receive a run ID to track the task's execution. [See the documentation](https://docs.airplane.dev/reference/api#tasks-execute)

Version:0.0.1

Key:airplane-execute-task

View on GitHub

Airplane Overview#

The Airplane API facilitates the creation and management of tasks and runs within the Airplane toolkit, which is geared towards automating developer operations and internal tools. In Pipedream, you can leverage this API to automate workflows, integrate with various services, and handle background tasks. By connecting Airplane to other apps on Pipedream, you can streamline processes like deploying code, managing feature flags, or orchestrating complex workflows that interact with other APIs and services.

Action Code#

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

export default {
  key: "airplane-execute-task",
  name: "Execute Task",
  description: "Execute a task with a set of parameter values and receive a run ID to track the task's execution. [See the documentation](https://docs.airplane.dev/reference/api#tasks-execute)",
  version: "0.0.1",
  type: "action",
  props: {
    airplane,
    id: {
      type: "string",
      label: "Task ID",
      description: "Unique ID of the task. You can find your task's ID by visiting the task's page on Airplane. The task ID is located at the end of the url. e.g. the task ID for `https://app.airplane.dev/tasks/tsk20210728zxb2vxn` is `tsk20210728zxb2vxn` Either an ID or a slug must be provided.",
      optional: true,
    },
    slug: {
      type: "string",
      label: "Slug",
      description: "Unique slug of the task. You can find your task's slug next to the task's name within the task editor on Airplane or by running `airplane tasks list` from the CLI. Either an ID or a slug must be provided.",
      optional: true,
    },
    paramValues: {
      type: "object",
      label: "Parameter Values",
      description: "Mapping of parameter slug to value. You can find your task's parameter slugs inside the task editor on Airplane or by running `airplane tasks list` from the CLI.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.id && !this.slug) {
      throw new ConfigurationError("Either an ID or a slug must be provided.");
    }

    const response = await this.airplane.executeTask({
      data: {
        id: this.id,
        slug: this.slug,
        paramValues: this.paramValues,
      },
      $,
    });

    if (response) {
      $.export("$summary", "Successfully executed task.");
    }

    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
Airplane	`airplane`	`app`	This component uses the Airplane app.
Task ID	`id`	`string`	Unique ID of the task. You can find your task's ID by visiting the task's page on Airplane. The task ID is located at the end of the url. e.g. the task ID for `https://app.airplane.dev/tasks/tsk20210728zxb2vxn` is `tsk20210728zxb2vxn` Either an ID or a slug must be provided.
Slug	`slug`	`string`	Unique slug of the task. You can find your task's slug next to the task's name within the task editor on Airplane or by running `airplane tasks list` from the CLI. Either an ID or a slug must be provided.
Parameter Values	`paramValues`	`object`	Mapping of parameter slug to value. You can find your task's parameter slugs inside the task editor on Airplane or by running `airplane tasks list` from the CLI.