Launch Phantom with Phantombuster API on Daily schedule from Schedule API

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

Trigger workflow on

Daily schedule from the Schedule API

Next, do this

Launch Phantom with the Phantombuster API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Schedule trigger and Phantombuster action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Daily schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Launch Phantom action
1. Connect your Phantombuster account
2. Select a Agent ID
3. Optional- Configure Arguments
4. Optional- Configure Save Arguments
5. Optional- Configure Bonus Argument
6. Optional- Configure Manual Launch
7. Optional- Configure Max Instance Count
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#

Daily schedule on Schedule

Description:Trigger your workflow every day.

Version:0.0.1

Key:schedule-daily

View on GitHub

Schedule Overview#

With Schedule - A trigger provided by Pipedream - You can easily build
automated workflows that run on regular times or intervals. Some examples of
things that you can build using the Schedule API include:

Automated data retrieval from a third-party service, like pulling stats from
your Salesforce account on a set schedule.
Uploading new data sets to a database with a predetermined interval.
Automatic emails to customers or leads at a certain time of the day.
Automating data analysis based on a set schedule.
Automatically optimizing social media postings according to a specified
timeline.
Updating webpages at a certain interval with newly available content.
Re-running reports on a periodic basis.
Refreshing a cache of data at a given frequency.

Trigger Code#

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

export default {
  name: "Daily schedule",
  version: "0.0.1",
  key: "schedule-daily",
  type: "source",
  description: "Trigger your workflow every day.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 11 * * *",
      },
    },
  },
};

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#

Launch Phantom on Phantombuster

Description:Adds an agent to the launch queue, [See the docs](https://hub.phantombuster.com/reference/post_agents-launch-1)

Version:0.0.1

Key:phantombuster-launch-phantom

View on GitHub

Phantombuster Overview#

Phantombuster is a tool that lets you automate interactions with web platforms to extract data, manage social media campaigns, and automate web actions. Using its API on Pipedream, you can seamlessly integrate these automation capabilities into complex workflows. Imagine orchestrating a symphony where Phantombuster plays the strings—pulling data from LinkedIn, sending tailored tweets, or automating lead generation—while Pipedream conducts, integrating these actions with other apps and services for a harmonious data-driven performance.

Action Code#

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

export default {
  type: "action",
  key: "phantombuster-launch-phantom",
  version: "0.0.1",
  name: "Launch Phantom",
  description: "Adds an agent to the launch queue, [See the docs](https://hub.phantombuster.com/reference/post_agents-launch-1)",
  props: {
    app,
    agentId: {
      propDefinition: [
        app,
        "agentId",
      ],
    },
    arguments: {
      type: "string",
      label: "Arguments",
      description: "Agent arguments. Must be a JSON string, e.g. `{\"key1\": \"Value 1\", \"key2\": \"Value 2\"}`",
      optional: true,
    },
    saveArguments: {
      type: "boolean",
      label: "Save Arguments",
      description: "If true, argument will be saved as the default launch options for the agent.",
      optional: true,
    },
    bonusArgument: {
      type: "string",
      label: "Bonus Argument",
      description: "Agent bonus argument. This bonus argument is single-use, it will only be used for the current launch. Must be a JSON string, e.g. `{\"key1\": \"Value 1\", \"key2\": \"Value 2\"}`",
      optional: true,
    },
    manualLaunch: {
      type: "boolean",
      label: "Manual Launch",
      description: "If set, the agent will be considered as `launched manually`.",
      optional: true,
    },
    maxInstanceCount: {
      type: "integer",
      label: "Max Instance Count",
      description: "If set, the agent will only be launched if the number of already running instances is below the specified number.",
      optional: true,
    },
  },
  async run ({ $ }) {
    const resp = await this.app.launchPhantom({
      $,
      data: {
        id: this.agentId,
        arguments: this.arguments,
        saveArguments: this.saveArguments,
        bonusArgument: this.bonusArgument,
        manualLaunch: this.manualLaunch,
        maxInstanceCount: this.maxInstanceCount,
      },
    });
    $.export("$summary", `Phantom has been launched succesfully. Container ID(${resp.containerId})`);
    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
Phantombuster	`app`	`app`	This component uses the Phantombuster app.
Agent ID	`agentId`	`string`	Select a value from the drop down menu.
Arguments	`arguments`	`string`	Agent arguments. Must be a JSON string, e.g. `{"key1": "Value 1", "key2": "Value 2"}`
Save Arguments	`saveArguments`	`boolean`	If true, argument will be saved as the default launch options for the agent.
Bonus Argument	`bonusArgument`	`string`	Agent bonus argument. This bonus argument is single-use, it will only be used for the current launch. Must be a JSON string, e.g. `{"key1": "Value 1", "key2": "Value 2"}`
Manual Launch	`manualLaunch`	`boolean`	If set, the agent will be considered as `launched manually`.
Max Instance Count	`maxInstanceCount`	`integer`	If set, the agent will only be launched if the number of already running instances is below the specified number.

Action Authentication#

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

Your API key resides in your Phantombuster Org settings page. This page is also accessible through your navbar's menu, under the label "Org settings". Please notice that for security reasons, you key will only be shown once, on creation. You better copy it in a safe place before refreshing or leaving the page.

For more info, refer to Phantombuster's API documentation.