Create Request with HelpSpot API on Daily schedule from Schedule API

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

Trigger workflow on

Daily schedule from the Schedule API

Next, do this

Create Request with the HelpSpot 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 HelpSpot 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 Create Request action
1. Connect your HelpSpot account
2. Configure Note
3. Select a Category
4. Optional- Select a Note Type
5. Optional- Select a Note Is HTML?
6. Optional- Configure Subject
7. Optional- Select a Status
8. Optional- Configure User Id
9. Optional- Configure First Name
10. Optional- Configure Last Name
11. Optional- Configure Email
12. Optional- Configure Phone
13. Optional- Configure Urgent
14. Optional- Select a Opened Via
15. Optional- Select a Send Email From
16. Optional- Configure Email CC
17. Optional- Configure Email BCC
18. Optional- Select one or more Email Staff
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#

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: "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#

Create Request on HelpSpot

Description:Creates a new user request. [See the documentation](https://support.helpspot.com/index.php?pg=kb.page&id=164#private.request.create)

Version:0.0.1

Key:helpspot-create-request

View on GitHub

Action Code#

import { parseObject } from "../../common/utils.mjs";
import common from "../common/request-base.mjs";

export default {
  ...common,
  key: "helpspot-create-request",
  name: "Create Request",
  description: "Creates a new user request. [See the documentation](https://support.helpspot.com/index.php?pg=kb.page&id=164#private.request.create)",
  version: "0.0.1",
  type: "action",
  methods: {
    getValidation() {
      if (!this.sFirstName && !this.sLastName && !this.sUserId && !this.sEmail && !this.sPhone) {
        throw new Error("You must provide at least one of the following: First Name, Last Name, User ID, Email, or Phone.");
      }
    },
    getFunction() {
      return this.helpspot.createRequest;
    },
    getData() {
      return {
        tNote: this.tNote,
        xCategory: this.xCategory,
        fNoteType: this.fNoteType && parseInt(this.fNoteType),
        fNoteIsHTML: this.fNoteIsHTML && parseInt(this.fNoteIsHTML),
        sTitle: this.sTitle,
        xStatus: this.xStatus,
        sUserId: this.sUserId,
        sFirstName: this.sFirstName,
        sLastName: this.sLastName,
        sEmail: this.sEmail,
        sPhone: this.sPhone,
        fUrgent: +this.fUrgent,
        fOpenedVia: this.fOpenedVia,
        email_from: this.emailFrom,
        email_cc: parseObject(this.emailCC)?.join(),
        email_bcc: parseObject(this.emailBCC)?.join(),
        email_staff: parseObject(this.emailStaff)?.join(),
      };
    },
    getSummary(response) {
      return `Successfully created request with Id: ${response.xRequest}`;
    },
  },
};

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
HelpSpot	`helpspot`	`app`	This component uses the HelpSpot app.
Note	`tNote`	`string`	The note of the request
Category	`xCategory`	`string`	Select a value from the drop down menu.
Note Type	`fNoteType`	`string`	Select a value from the drop down menu:`{ "label": "Private", "value": "0" }{ "label": "Public", "value": "1" }{ "label": "External", "value": "2" }`
Note Is HTML?	`fNoteIsHTML`	`string`	Select a value from the drop down menu:`{ "label": "Text", "value": "0" }{ "label": "HTML", "value": "1" }`
Subject	`sTitle`	`string`	The title used as email subject
Status	`xStatus`	`string`	Select a value from the drop down menu.
User Id	`sUserId`	`string`	The Id of the customer
First Name	`sFirstName`	`string`	The first name of the request creator
Last Name	`sLastName`	`string`	The last name of the request creator
Email	`sEmail`	`string`	The email of the request creator
Phone	`sPhone`	`string`	The phone number of the request creator
Urgent	`fUrgent`	`boolean`	Whether the request is urgent or not
Opened Via	`fOpenedVia`	`integer`	Select a value from the drop down menu:`{ "label": "Email", "value": 1 }{ "label": "Phone", "value": 2 }{ "label": "Walk In", "value": 3 }{ "label": "Mail", "value": 4 }{ "label": "Other", "value": 5 }{ "label": "Web Service", "value": 6 }{ "label": "Web Form", "value": 7 }{ "label": "Forum", "value": 8 }{ "label": "Instant Messenger", "value": 9 }{ "label": "Fax", "value": 10 }{ "label": "Voicemail", "value": 11 }{ "label": "Staff Initiated", "value": 12 }{ "label": "Tab Widget", "value": 13 }`
Send Email From	`emailFrom`	`string`	Select a value from the drop down menu.
Email CC	`emailCC`	`string[]`	A list of emails to CC on the request
Email BCC	`emailBCC`	`string[]`	A list of emails to BCC on the request
Email Staff	`emailStaff`	`string[]`	Select a value from the drop down menu.