Search Contacts with Twilio SendGrid API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search Contacts with the Twilio SendGrid 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#

Create a workflow to Search Contacts with the Twilio SendGrid API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Contacts action
1. Connect your Twilio SendGrid account
2. Optional- Configure Query
3. Optional- Select a Query Field
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search Contacts with Twilio SendGrid API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Twilio SendGrid

Try it

Search Contacts with Twilio SendGrid API on New Message from Discord API

Discord + Twilio SendGrid

Try it

Search Contacts with Twilio SendGrid API on New Message In Channels from Slack API

Slack + Twilio SendGrid

Try it

Search Contacts with Twilio SendGrid API on New Message in Channel from Discord Bot API

Discord Bot + Twilio SendGrid

Try it

Search Contacts with Twilio SendGrid API on New Submission from Typeform API

Typeform + Twilio SendGrid

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Search Contacts on Twilio SendGrid

Description:Searches contacts with a SGQL query. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/search-contacts)

Version:0.0.3

Key:sendgrid-search-contacts

View on GitHub

Code#

import common from "../common/common.mjs";
import constants from "../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  ...common,
  key: "sendgrid-search-contacts",
  name: "Search Contacts",
  description: "Searches contacts with a SGQL query. [See the docs here](https://docs.sendgrid.com/api-reference/contacts/search-contacts)",
  version: "0.0.3",
  type: "action",
  props: {
    ...common.props,
    query: {
      type: "string",
      label: "Query",
      description: "The query field accepts valid SGQL for searching for a contact (.e.g `email LIKE 'hung.v%'` ). Only the first 50 contacts will be returned. [For more information about SGQL](https://docs.sendgrid.com/for-developers/sending-email/segmentation-query-language)",
      optional: true,
    },
    queryField: {
      type: "string",
      label: "Query Field",
      description: "Select the field to search",
      options: constants.CONTACT_FIELDS,
      reloadProps: true,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.queryField) {
      props.queryValue = {
        type: "string",
        label: "Query Value",
        description: `The ${this.queryField} value to search for`,
      };
      props.matchCase = {
        type: "string",
        label: "Query Match Case",
        description: "`Exact` will return only exact matches. `Fuzzy` is case insensitive and will return matches that include the search term.",
        options: constants.QUERY_MATCH_CASE_OPTIONS,
        default: "Fuzzy",
      };
    }
    return props;
  },
  async run({ $ }) {
    const {
      query,
      queryField,
      queryValue,
      matchCase,
    } = this;

    if ((query && queryField) || (!query && !queryField)) {
      throw new ConfigurationError("Please enter only one of `query` or `queryField`");
    }

    let q;
    if (query) {
      q = query;
    } else {
      q = matchCase === "Fuzzy"
        ? `lower(${queryField}) LIKE '%${queryValue}%'`
        : `${queryField} = '${queryValue}'`;
    }

    console.log(q);
    const resp = await this.sendgrid.searchContacts(q);
    $.export("$summary", "Successfully completed search");
    return resp;
  },
};

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
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
Query	`query`	`string`	The query field accepts valid SGQL for searching for a contact (.e.g `email LIKE 'hung.v%'` ). Only the first 50 contacts will be returned. For more information about SGQL
Query Field	`queryField`	`string`	Select a value from the drop down menu:`alternate_emailsaddress_line_1address_line_2citycontact_idcountryemailemail_domainsevent_dataevent_sourceevent_timestampevent_typefirst_namelast_namepostal_codestate_province_regioncreated_atupdated_at`