Get Contents with Exa API on New Contact from Twilio SendGrid API

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

Trigger workflow on

New Contact from the Twilio SendGrid API

Next, do this

Get Contents with the Exa 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 Exa 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 Get Contents action
1. Connect your Exa account
2. Configure URLs
3. Optional- Configure Include Text
4. Optional- Configure Highlights Num Sentences
5. Optional- Configure Highlights Per URL
6. Optional- Configure Highlights Query
7. Optional- Configure Summary Query
8. Optional- Configure Summary Schema
9. Optional- Select a Live Crawl
10. Optional- Configure Live Crawl Timeout
11. Optional- Configure Subpages
12. Optional- Configure Subpage Target
13. Optional- Configure Extras Links
14. Optional- Configure Extras Image Links
15. Optional- Configure Include Context
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#

Get Contents on Exa

Description:Retrieves full page contents, summaries, and metadata for a list of URLs. Uses cached results with optional live crawling fallback. [See the documentation](https://docs.exa.ai/reference/get-contents)

Version:0.0.1

Key:exa-get-contents

View on GitHub

Action Code#

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

export default {
  key: "exa-get-contents",
  name: "Get Contents",
  description: "Retrieves full page contents, summaries, and metadata for a list of URLs. Uses cached results with optional live crawling fallback. [See the documentation](https://docs.exa.ai/reference/get-contents)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    app,
    urls: {
      propDefinition: [
        app,
        "urls",
      ],
    },
    text: {
      description: "If `true`, returns full page text with default settings. If `false`, disables text return.",
      propDefinition: [
        app,
        "text",
      ],
    },
    highlightsNumSentences: {
      propDefinition: [
        app,
        "highlightsNumSentences",
      ],
    },
    highlightsPerUrl: {
      propDefinition: [
        app,
        "highlightsPerUrl",
      ],
    },
    highlightsQuery: {
      propDefinition: [
        app,
        "highlightsQuery",
      ],
    },
    summaryQuery: {
      propDefinition: [
        app,
        "summaryQuery",
      ],
    },
    summarySchema: {
      propDefinition: [
        app,
        "summarySchema",
      ],
    },
    livecrawl: {
      propDefinition: [
        app,
        "livecrawl",
      ],
    },
    livecrawlTimeout: {
      type: "integer",
      label: "Live Crawl Timeout",
      description: "Timeout in milliseconds for live crawling (default: 10000)",
      optional: true,
    },
    subpages: {
      propDefinition: [
        app,
        "subpages",
      ],
    },
    subpageTarget: {
      propDefinition: [
        app,
        "subpageTarget",
      ],
    },
    extrasLinks: {
      propDefinition: [
        app,
        "extrasLinks",
      ],
    },
    extrasImageLinks: {
      propDefinition: [
        app,
        "extrasImageLinks",
      ],
    },
    context: {
      description: "Return page contents as a context string for LLM. When true, combines all result contents into one string. We recommend using 10000+ characters for best results, though no limit works best. Context strings often perform better than highlights for RAG applications.",
      propDefinition: [
        app,
        "context",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      urls,
      text,
      highlightsNumSentences,
      highlightsPerUrl,
      highlightsQuery,
      summaryQuery,
      summarySchema,
      livecrawl,
      livecrawlTimeout,
      subpages,
      subpageTarget,
      extrasLinks,
      extrasImageLinks,
      context,
    } = this;

    let parsedSchema;
    if (summarySchema) {
      if (typeof summarySchema === "string") {
        try {
          parsedSchema = JSON.parse(summarySchema);
        } catch (error) {
          throw new ConfigurationError(`Invalid JSON schema format: ${error.message}. Please provide a valid JSON object.`);
        }
      } else {
        parsedSchema = summarySchema;
      }
    }

    const response = await app.getContents({
      $,
      data: {
        urls,
        text,
        livecrawl,
        livecrawlTimeout,
        subpages,
        subpageTarget,
        context,
        ...(extrasLinks
        || extrasImageLinks
          ? {
            extras: {
              links: extrasLinks,
              imageLinks: extrasImageLinks,
            },
          }
          : undefined
        ),
        ...(highlightsNumSentences
          || highlightsPerUrl
          || highlightsQuery
          ? {
            highlights: {
              numSentences: highlightsNumSentences,
              highlightsPerUrl,
              query: highlightsQuery,
            },
          }
          : undefined
        ),
        ...(summaryQuery
          || summarySchema
          ? {
            summary: {
              query: summaryQuery,
              schema: parsedSchema,
            },
          }
          : undefined
        ),
      },
    });

    $.export("$summary", `Successfully retrieved contents with ID \`${response.requestId}\`.`);
    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
Exa	`app`	`app`	This component uses the Exa app.
URLs	`urls`	`string[]`	List of URLs to retrieve contents for
Include Text	`text`	`boolean`	If `true`, returns full page text with default settings. If `false`, disables text return.
Highlights Num Sentences	`highlightsNumSentences`	`integer`	The number of sentences to return for each snippet.
Highlights Per URL	`highlightsPerUrl`	`integer`	The number of snippets to return for each result.
Highlights Query	`highlightsQuery`	`string`	Custom query to direct the LLM's selection of highlights.
Summary Query	`summaryQuery`	`string`	Custom query to guide summary generation
Summary Schema	`summarySchema`	`object`	JSON schema for structured output from summary. See JSON Schema documentation for details. Example: `{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "Title", "type": "object", "properties": { "Property 1": { "type": "string", "description": "Description" }, "Property 2": { "type": "string", "enum": ["option 1", "option 2", "option 3"], "description": "Description" } }, "required": ["Property 1"] }`
Live Crawl	`livecrawl`	`string`	Select a value from the drop down menu:`neverfallbackalwayspreferred`
Live Crawl Timeout	`livecrawlTimeout`	`integer`	Timeout in milliseconds for live crawling (default: 10000)
Subpages	`subpages`	`integer`	Number of subpages to crawl per result
Subpage Target	`subpageTarget`	`string`	Keywords to identify specific subpages to crawl
Extras Links	`extrasLinks`	`integer`	Number of URLs to return from each webpage.
Extras Image Links	`extrasImageLinks`	`integer`	Number of images to return for each result.
Include Context	`context`	`boolean`	Return page contents as a context string for LLM. When true, combines all result contents into one string. We recommend using 10000+ characters for best results, though no limit works best. Context strings often perform better than highlights for RAG applications.