Track Event with GoSquared API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid 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 Twilio SendGrid 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 New Contact trigger
1. Connect your Twilio SendGrid account
2. Configure timer
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#

New Contact on Twilio SendGrid

Description:Emit new event when a new contact is created

Version:0.0.8

Key:sendgrid-new-contact

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to 3,000+ other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import orderBy from "lodash/orderBy.js";
import common from "../common/timer-based.mjs";

export default {
  ...common,
  key: "sendgrid-new-contact",
  name: "New Contact",
  description: "Emit new event when a new contact is created",
  version: "0.0.8",
  type: "source",
  dedupe: "unique",
  hooks: {
    async activate() {
      const currentTimestamp = Date.now();
      const state = {
        processedItems: [],
        lowerTimestamp: currentTimestamp,
        upperTimestamp: currentTimestamp,
      };
      this.db.set("state", state);
    },
  },
  methods: {
    ...common.methods,
    _maxDelayTime() {
      // There is no report from SendGrid as to how much time it takes
      // for a contact to be created and appear in search results, so
      // we're using a rough estimate of 30 minutes here.
      return 30 * 60 * 1000;  // 30 minutes, in milliseconds
    },
    _addDelayOffset(timestamp) {
      return timestamp - this._maxDelayTime();
    },
    _cleanupOldProcessedItems(processedItems, currentTimestamp) {
      return processedItems
        .map((item) => ({
          // We just need to keep track of the record ID and
          // its creation date.
          id: item.id,
          created_at: item.created_at,
        }))
        .filter((item) => {
          const { created_at: createdAt } = item;
          const createdAtTimestamp = Date.parse(createdAt);
          const cutoffTimestamp = this._addDelayOffset(currentTimestamp);
          return createdAtTimestamp > cutoffTimestamp;
        });
    },
    _makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp) {
      const idList = processedItems
        .map((item) => item.id)
        .map((id) => `'${id}'`)
        .join(", ")
      || "''";
      const startTimestamp = this._addDelayOffset(lowerTimestamp);
      const startDate = this.toISOString(startTimestamp);
      const endDate = this.toISOString(upperTimestamp);
      return `
        contact_id NOT IN (${idList}) AND
        created_at BETWEEN
          TIMESTAMP '${startDate}' AND
          TIMESTAMP '${endDate}'
      `;
    },
    generateMeta(data) {
      const {
        item,
        eventTimestamp: ts,
      } = data;
      const {
        id,
        email,
      } = item;
      const slugifiedEmail = this.slugifyEmail(email);
      const summary = `New contact: ${slugifiedEmail}`;
      return {
        id,
        summary,
        ts,
      };
    },
    async processEvent(event) {
      // Transform the timer timestamp to milliseconds
      // to be consistent with how Javascript handles timestamps.
      const eventTimestamp = event.timestamp * 1000;

      // Retrieve the current state of the component.
      const {
        processedItems,
        lowerTimestamp,
        upperTimestamp,
      } = this.db.get("state");

      // Search for contacts within a specific timeframe, excluding
      // items that have already been processed.
      const query = this._makeSearchQuery(processedItems, lowerTimestamp, upperTimestamp);
      const {
        result: items,
        contact_count: contactCount,
      } = await this.sendgrid.searchContacts(query);

      // If no contacts have been retrieved via the API,
      // move the time window forward to possibly capture newer contacts.
      if (contactCount === 0) {
        const newState = {
          processedItems: this._cleanupOldProcessedItems(processedItems, lowerTimestamp),
          lowerTimestamp: upperTimestamp,
          upperTimestamp: eventTimestamp,
        };
        this.db.set("state", newState);
        return;
      }

      // We process the searched records from oldest to newest.
      const itemsToProcess = orderBy(items, "created_at");
      itemsToProcess
        .forEach((item) => {
          const meta = this.generateMeta({
            item,
            eventTimestamp,
          });
          this.$emit(item, meta);
        });

      // Use the timestamp of the last processed record as a lower bound for
      // following searches. This bound will be subjected to an offset so in
      // case older records appear in future search results, but have not
      // appeared until now, can be processed. We only adjust it if it means
      // moving forward, not backwards. Otherwise, we might start retrieving
      // older and older records indefinitely (and we're all about *new*
      // records!)
      const newLowerTimestamp = Math.max(
        lowerTimestamp,
        Date.parse(itemsToProcess[0].created_at),
      );

      // If the total contact count is less than 100, it means that during the
      // next iteration the search results count will most likely be less than
      // 50. In that case, if we extend the upper bound of the search time range
      // we might be able to retrieve more records.
      const newUpperTimestamp = contactCount < 100
        ? eventTimestamp
        : upperTimestamp;

      // The list of processed items can grow indefinitely.
      // Since we don't want to keep track of every processed record
      // ever, we need to clean up this list, removing any records
      // that are no longer relevant.
      const newProcessedItems = this._cleanupOldProcessedItems(
        [
          ...processedItems,
          ...itemsToProcess,
        ],
        newLowerTimestamp,
      );

      // Update the state of the component to reflect the computations
      // made above.
      const newState = {
        processedItems: newProcessedItems,
        lowerTimestamp: newLowerTimestamp,
        upperTimestamp: newUpperTimestamp,
      };
      this.db.set("state", newState);
    },
  },
};

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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

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.

Action Authentication#

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

You can manage your API keys under the API Access section of your account settings

About GoSquared#

GoSquared is the modern growth platform – designed to enable sales and marketing teams to collaborate more effectively and turn visitors into successful customers, effortlessly.

More Ways to Connect GoSquared + Twilio SendGrid#

Other Popular Integrations#

Create/Update Profile with GoSquared API on New Events (Instant) from Twilio SendGrid API

Twilio SendGrid + GoSquared

Track Event with GoSquared API on New Contact from Twilio SendGrid API

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

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

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular