Find Jobs with VisualPing API on New Contact from Twilio SendGrid API

Pipedream makes it easy to connect APIs for VisualPing, Twilio SendGrid and 2,400+ other apps remarkably fast.

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Find Jobs with the VisualPing 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 VisualPing 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 Find Jobs action
1. Connect your VisualPing account
2. Optional- Configure Organisation Id
3. Optional- Select a Workspace ID
4. Optional- Select a Mode
5. Optional- Configure Active Filter
6. Optional- Configure In Progress Filter
7. Optional- Select one or more Mode Filter
8. Optional- Select one or more Frequency Filter
9. Optional- Configure Has Advanced Schedule Filter
10. Optional- Select a Changed Filter
11. Optional- Configure Changed Filter Date Min
12. Optional- Configure Changed Filter Date Max
13. Optional- Configure Full Text Search Filter
14. Optional- Select a Sort By
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.6

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 hundreds of 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.6",
  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#

Find Jobs on VisualPing

Description:Find existing jobs using filters. [See the docs here](https://develop.api.visualping.io/doc.html#tag/Jobs/paths/~1v2~1jobs/get)

Version:0.0.1

Key:visualping-find-jobs

View on GitHub

VisualPing Overview#

VisualPing is a tool that lets you monitor web pages for changes. Using its API with Pipedream, you can automate reactions to those changes. For instance, you can set up workflows that notify you or your team when specific parts of a web page update, or use changes to trigger downstream actions in other apps. Pipedream's serverless platform enables you to connect VisualPing with a vast array of apps to create custom, automated workflows without writing a lot of code.

Action Code#

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

export default {
  key: "visualping-find-jobs",
  name: "Find Jobs",
  version: "0.0.1",
  description: "Find existing jobs using filters. [See the docs here](https://develop.api.visualping.io/doc.html#tag/Jobs/paths/~1v2~1jobs/get)",
  type: "action",
  props: {
    visualping,
    organisationId: {
      propDefinition: [
        visualping,
        "organisationId",
      ],
      optional: true,
    },
    workspaceId: {
      propDefinition: [
        visualping,
        "workspaceId",
      ],
      optional: true,
    },
    mode: {
      type: "string",
      label: "Mode",
      description: "API output mode",
      options: [
        {
          label: "Counts Only",
          value: "counts_only",
        },
        {
          label: "Id And WsIds",
          value: "id_and_wsIds",
        },
        {
          label: "Ids Only",
          value: "ids_only",
        },
        {
          label: "Normal",
          value: "normal",
        },
      ],
      optional: true,
    },
    activeFilter: {
      type: "boolean",
      label: "Active Filter",
      description: "Filters for active or inactive (paused) jobs.",
      optional: true,
    },
    inProgressFilter: {
      type: "boolean",
      label: "In Progress Filter",
      description: "Filters for jobs that are currently checking the web page.",
      optional: true,
    },
    modeFilter: {
      type: "string[]",
      label: "Mode Filter",
      description: "Filters jobs by mode. Multiple choices are allowed.",
      options: [
        {
          label: "Visual",
          value: "VISUAL",
        },
        {
          label: "Web",
          value: "WEB",
        },
        {
          label: "text",
          value: "TEXT",
        },
      ],
      optional: true,
    },
    frequencyFilter: {
      type: "string[]",
      label: "Frequency Filter",
      description: "Filters jobs by scheduling frequency. Multiple choices allowed.",
      options: [
        "below_1h_excl",
        "1hr",
        "1h_excl_to_1d_excl",
        "1d",
        "1d_excl_to_500h_excl",
        "above_500h_incl",
      ],
      optional: true,
    },
    hasAdvancedScheduleFilter: {
      type: "boolean",
      label: "Has Advanced Schedule Filter",
      description: "Filters jobs by presence of an advanced schedule.",
      optional: true,
    },
    changedFilter: {
      type: "string",
      label: "Changed Filter",
      description: "Filters jobs by the presence of a detected change.",
      options: [
        {
          label: "Before Custom Date",
          value: "before_custom_date",
        },
        {
          label: "Between Custom Dates",
          value: "between_custom_dates",
        },
        {
          label: "Since Custom Date",
          value: "since_custom_date",
        },
        {
          label: "Since Last Login",
          value: "since_last_login",
        },
        {
          label: "Since Last Month",
          value: "since_last_month",
        },
        {
          label: "Since Last Week",
          value: "since_last_week",
        },
        {
          label: "Since Yesterday",
          value: "since_yesterday",
        },
      ],
      optional: true,
    },
    changedFilterDateMin: {
      type: "string",
      label: "Changed Filter Date Min",
      description: "Necessary if `changedFilter` expects a lower bound timestamp.",
      optional: true,
    },
    changedFilterDateMax: {
      type: "string",
      label: "Changed Filter Date Max",
      description: "Necessary if `changedFilter` expects an upper bound timestamp.",
      optional: true,
    },
    fullTextSearchFilter: {
      type: "string",
      label: "Full Text Search Filter",
      description: "Filters jobs by the presence of a given substring in their URLs or descriptions.",
      optional: true,
    },
    sortBy: {
      type: "string",
      label: "Sort By",
      description: "For internal use.",
      options: [
        {
          label: "Active First",
          value: "active_first",
        },
        {
          label: "Alphabetical Asc",
          value: "alphabetical_asc",
        },
        {
          label: "Alphabetical Desc",
          value: "alphabetical_desc",
        },
        {
          label: "Created Asc",
          value: "created_asc",
        },
        {
          label: "Created Desc",
          value: "created_desc",
        },
        {
          label: "Frequency Asc",
          value: "frequency_asc",
        },
        {
          label: "Frequency Desc",
          value: "frequency_desc",
        },
        {
          label: "Id Asc",
          value: "id_asc",
        },
        {
          label: "Id Desc",
          value: "id_desc",
        },
        {
          label: "Inactive First",
          value: "inactive_first",
        },
        {
          label: "Last Diff Detected Asc",
          value: "last_diff_detected_asc",
        },
        {
          label: "Last Diff Detected Desc",
          value: "last_diff_detected_desc",
        },
        {
          label: "Lastrun Asc",
          value: "lastrun_asc",
        },
        {
          label: "Lastrun Desc",
          value: "lastrun_desc",
        },
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      visualping,
      activeFilter,
      inProgressFilter,
      hasAdvancedScheduleFilter,
      ...params
    } = this;

    const response = [];

    const items = visualping.paginate({
      fn: visualping.findJobs,
      params: {
        ...params,
        activeFilter: (activeFilter != undefined)
          ? +activeFilter
          : null,
        inProgressFilter: (inProgressFilter != undefined)
          ? +inProgressFilter
          : null,
        hasAdvancedScheduleFilter: (hasAdvancedScheduleFilter != undefined)
          ? +hasAdvancedScheduleFilter
          : null,
      },
    });

    for await (const item of items) {
      response.push(item);
    }

    const length = response.length;

    $.export("$summary", `${length} job${length > 1
      ? "s were"
      : " was"} successfully fetched!`);
    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
VisualPing	`visualping`	`app`	This component uses the VisualPing app.
Organisation Id	`organisationId`	`string`	Unique ID of the organisation.
Workspace ID	`workspaceId`	`string`	Select a value from the drop down menu.
Mode	`mode`	`string`	Select a value from the drop down menu:`{ "label": "Counts Only", "value": "counts_only" }{ "label": "Id And WsIds", "value": "id_and_wsIds" }{ "label": "Ids Only", "value": "ids_only" }{ "label": "Normal", "value": "normal" }`
Active Filter	`activeFilter`	`boolean`	Filters for active or inactive (paused) jobs.
In Progress Filter	`inProgressFilter`	`boolean`	Filters for jobs that are currently checking the web page.
Mode Filter	`modeFilter`	`string[]`	Select a value from the drop down menu:`{ "label": "Visual", "value": "VISUAL" }{ "label": "Web", "value": "WEB" }{ "label": "text", "value": "TEXT" }`
Frequency Filter	`frequencyFilter`	`string[]`	Select a value from the drop down menu:`below_1h_excl1hr1h_excl_to_1d_excl1d1d_excl_to_500h_exclabove_500h_incl`
Has Advanced Schedule Filter	`hasAdvancedScheduleFilter`	`boolean`	Filters jobs by presence of an advanced schedule.
Changed Filter	`changedFilter`	`string`	Select a value from the drop down menu:`{ "label": "Before Custom Date", "value": "before_custom_date" }{ "label": "Between Custom Dates", "value": "between_custom_dates" }{ "label": "Since Custom Date", "value": "since_custom_date" }{ "label": "Since Last Login", "value": "since_last_login" }{ "label": "Since Last Month", "value": "since_last_month" }{ "label": "Since Last Week", "value": "since_last_week" }{ "label": "Since Yesterday", "value": "since_yesterday" }`
Changed Filter Date Min	`changedFilterDateMin`	`string`	Necessary if `changedFilter` expects a lower bound timestamp.
Changed Filter Date Max	`changedFilterDateMax`	`string`	Necessary if `changedFilter` expects an upper bound timestamp.
Full Text Search Filter	`fullTextSearchFilter`	`string`	Filters jobs by the presence of a given substring in their URLs or descriptions.
Sort By	`sortBy`	`string`	Select a value from the drop down menu:`{ "label": "Active First", "value": "active_first" }{ "label": "Alphabetical Asc", "value": "alphabetical_asc" }{ "label": "Alphabetical Desc", "value": "alphabetical_desc" }{ "label": "Created Asc", "value": "created_asc" }{ "label": "Created Desc", "value": "created_desc" }{ "label": "Frequency Asc", "value": "frequency_asc" }{ "label": "Frequency Desc", "value": "frequency_desc" }{ "label": "Id Asc", "value": "id_asc" }{ "label": "Id Desc", "value": "id_desc" }{ "label": "Inactive First", "value": "inactive_first" }{ "label": "Last Diff Detected Asc", "value": "last_diff_detected_asc" }{ "label": "Last Diff Detected Desc", "value": "last_diff_detected_desc" }{ "label": "Lastrun Asc", "value": "lastrun_asc" }{ "label": "Lastrun Desc", "value": "lastrun_desc" }`

Action Authentication#

VisualPing uses OAuth authentication. When you connect your VisualPing account, Pipedream will open a popup window where you can sign into VisualPing and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any VisualPing API.

Pipedream requests the following authorization scopes when you connect your account:

Find Jobs with VisualPing API on New Contact from Twilio SendGrid API

Pipedream makes it easy to connect APIs for VisualPing, Twilio SendGrid and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular