Create Call with Hyros API on Monthly Schedule from Schedule API

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

Trigger workflow on

Monthly Schedule from the Schedule API

Next, do this

Create Call with the Hyros 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 Hyros action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Monthly Schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Call action
1. Connect your Hyros account
2. Configure Name
3. Optional- Configure Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Lead IPs
7. Optional- Configure Phone Numbers
8. Optional- Configure Id
9. Optional- Configure Date
10. Optional- Configure Qualified
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#

Monthly Schedule on Schedule

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

Version:0.0.2

Key:schedule-monthly

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: "Monthly Schedule",
  version: "0.0.2",
  key: "schedule-monthly",
  type: "source",
  description: "Trigger your workflow on one or more days each month 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#

Create Call on Hyros

Description:Create a new call. [See the documentation](https://hyros.docs.apiary.io/#reference/0/calls/create)

Version:0.0.1

Key:hyros-create-call

View on GitHub

Hyros Overview#

The Hyros API offers the ability to track and analyze customer interactions across various marketing channels, aiming to improve ad tracking and ROI. Integrated within Pipedream, it allows for the automation of data collection, real-time analytics, and operational workflows. By leveraging Pipedream's serverless platform, developers can create workflows that respond to events from Hyros, trigger actions based on data insights, or synchronize data with other apps seamlessly.

Action Code#

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

export default {
  key: "hyros-create-call",
  name: "Create Call",
  version: "0.0.1",
  description: "Create a new call. [See the documentation](https://hyros.docs.apiary.io/#reference/0/calls/create)",
  type: "action",
  props: {
    hyros,
    name: {
      type: "string",
      label: "Name",
      description: "The name of the call.",
    },
    email: {
      propDefinition: [
        hyros,
        "email",
      ],
      description: "Email associated with the lead that made the call.",
      optional: true,
    },
    firstName: {
      propDefinition: [
        hyros,
        "firstName",
      ],
      description: "First name of the lead that made the call.",
      optional: true,
    },
    lastName: {
      propDefinition: [
        hyros,
        "lastName",
      ],
      description: "Last name of the lead that made the call.",
      optional: true,
    },
    leadIps: {
      propDefinition: [
        hyros,
        "leadIps",
      ],
      description: "IPs of the customer that made the call. Will be used on the Ad attributing process.",
      optional: true,
    },
    phoneNumbers: {
      propDefinition: [
        hyros,
        "phoneNumbers",
      ],
      description: "Phone numbers of the lead that made the call. Will be used on the Ad attributing process.",
      optional: true,
    },
    id: {
      type: "string",
      label: "Id",
      description: "Identifier by which the call will be grouped. A default id will be assigned if it is not included.",
      optional: true,
    },
    date: {
      type: "string",
      label: "Date",
      description: "Date on which the transaction was processed. The date must be written in accordance with [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). Format: YYYY-MM-DDThh:mm:ss",
      optional: true,
    },
    qualified: {
      type: "boolean",
      label: "Qualified",
      description: "A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      hyros,
      ...data
    } = this;

    let response;
    try {
      response = await hyros.createCall({
        $,
        data,
      });
    } catch ({ response }) {
      throw new ConfigurationError(response.data.message[0]);
    }

    $.export("$summary", `A new call with Id: ${response.request_id} was successfully created!`);
    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
Hyros	`hyros`	`app`	This component uses the Hyros app.
Name	`name`	`string`	The name of the call.
Email	`email`	`string`	Email associated with the lead that made the call.
First Name	`firstName`	`string`	First name of the lead that made the call.
Last Name	`lastName`	`string`	Last name of the lead that made the call.
Lead IPs	`leadIps`	`string[]`	IPs of the customer that made the call. Will be used on the Ad attributing process.
Phone Numbers	`phoneNumbers`	`string[]`	Phone numbers of the lead that made the call. Will be used on the Ad attributing process.
Id	`id`	`string`	Identifier by which the call will be grouped. A default id will be assigned if it is not included.
Date	`date`	`string`	Date on which the transaction was processed. The date must be written in accordance with ISO 8601. Format: YYYY-MM-DDThh:mm:ss
Qualified	`qualified`	`boolean`	A flag that indicates if the call should be marked as unqualified. If it's not present the call is created as qualified.