Track Event with GoSquared API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Track Event action
1. Connect your GoSquared account
2. Select a Site Token
3. Configure Event Name
4. Optional- Configure Event Data
5. Optional- Configure Person ID
6. Optional- Configure Visitor ID
7. Optional- Configure Page URL
8. Optional- Configure Page Title
9. Optional- Configure Timestamp
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

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: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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#

Track Event on GoSquared

Description:Track an event in GoSquared. Events are a versatile way of tracking anything that is happening on your site or app. [See the documentation](https://www.gosquared.com/docs/tracking/event/)

Version:0.0.1

Key:gosquared-track-event

View on GitHub

GoSquared Overview#

GoSquared offers a powerful analytics platform which, when integrated via its API, enables a deep dive into website traffic, user behavior, and real-time analytics. The API can be used to track events, fetch analytics data, manage contacts, and trigger communications based on user actions. With Pipedream, you can harness this API to create custom workflows that react to data from GoSquared, automate tasks, and connect with countless other apps for a seamless data pipeline.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import gosquared from "../../gosquared.app.mjs";

export default {
  key: "gosquared-track-event",
  name: "Track Event",
  description: "Track an event in GoSquared. Events are a versatile way of tracking anything that is happening on your site or app. [See the documentation](https://www.gosquared.com/docs/tracking/event/)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    gosquared,
    siteToken: {
      propDefinition: [
        gosquared,
        "siteToken",
      ],
    },
    eventName: {
      type: "string",
      label: "Event Name",
      description: "The name of the event to track. Popular events are aggregated by name in the Trends dashboard.",
    },
    eventData: {
      type: "object",
      label: "Event Data",
      description: "Properties associated with this event. Note: event body data is not currently searchable, but it can be viewed on a per profile basis in People CRM.",
      optional: true,
    },
    personId: {
      type: "string",
      label: "Person ID",
      description: "The People person ID that this action is associated with. If the identifier used is an email it should be prefixed with email: like this: email:jon@example.com",
      optional: true,
    },
    visitorId: {
      type: "string",
      label: "Visitor ID",
      description: "The anonymous visitor ID that this action is associated with.",
      optional: true,
    },
    pageUrl: {
      type: "string",
      label: "Page URL",
      description: "The URL of the page where the event occurred",
      optional: true,
    },
    pageTitle: {
      type: "string",
      label: "Page Title",
      description: "The title of the page where the event occurred",
      optional: true,
    },
    timestamp: {
      type: "string",
      label: "Timestamp",
      description: "A valid ISO 8601 timestamp. If not provided, current time will be used.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.gosquared.trackEvent({
      $,
      data: {
        event: {
          name: this.eventName,
          data: parseObject(this.eventData),
        },
        timestamp: this.timestamp,
        person_id: this.personId,
        visitor_id: this.visitorId,
        page: {
          url: this.pageUrl,
          title: this.pageTitle,
        },
      },
      params: {
        site_token: this.siteToken,
      },
    });

    $.export("$summary", `Successfully tracked event: ${this.eventName}`);
    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
GoSquared	`gosquared`	`app`	This component uses the GoSquared app.
Site Token	`siteToken`	`string`	Select a value from the drop down menu.
Event Name	`eventName`	`string`	The name of the event to track. Popular events are aggregated by name in the Trends dashboard.
Event Data	`eventData`	`object`	Properties associated with this event. Note: event body data is not currently searchable, but it can be viewed on a per profile basis in People CRM.
Person ID	`personId`	`string`	The People person ID that this action is associated with. If the identifier used is an email it should be prefixed with email: like this: email:jon@example.com
Visitor ID	`visitorId`	`string`	The anonymous visitor ID that this action is associated with.
Page URL	`pageUrl`	`string`	The URL of the page where the event occurred
Page Title	`pageTitle`	`string`	The title of the page where the event occurred
Timestamp	`timestamp`	`string`	A valid ISO 8601 timestamp. If not provided, current time will be used.