List Global Suppressions with Twilio SendGrid API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

List Global Suppressions 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 List Global Suppressions with the Twilio SendGrid API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the List Global Suppressions action
1. Connect your Twilio SendGrid account
2. Optional- Configure Start Time
3. Optional- Configure End Time
4. Optional- Configure Max # of Global Suppressions to Return
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#

List Global Suppressions with Twilio SendGrid API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Twilio SendGrid

Try it

List Global Suppressions with Twilio SendGrid API on New Message from Discord API

Discord + Twilio SendGrid

Try it

List Global Suppressions with Twilio SendGrid API on New Message In Channels from Slack API

Slack + Twilio SendGrid

Try it

List Global Suppressions with Twilio SendGrid API on New Message in Channel from Discord Bot API

Discord Bot + Twilio SendGrid

Try it

List Global Suppressions 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.

List Global Suppressions on Twilio SendGrid

Description:Allows you to get a list of all email address that are globally suppressed. [See the docs here](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/retrieve-all-global-suppressions)

Version:0.0.5

Key:sendgrid-list-global-suppressions

View on GitHub

Code#

import validate from "validate.js";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "sendgrid-list-global-suppressions",
  name: "List Global Suppressions",
  description: "Allows you to get a list of all email address that are globally suppressed. [See the docs here](https://docs.sendgrid.com/api-reference/suppressions-global-suppressions/retrieve-all-global-suppressions)",
  version: "0.0.5",
  type: "action",
  props: {
    ...common.props,
    startTime: {
      propDefinition: [
        common.props.sendgrid,
        "startTime",
      ],
      description: "Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive)",
    },
    endTime: {
      propDefinition: [
        common.props.sendgrid,
        "endTime",
      ],
      description: "Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive)",
    },
    numberOfSupressions: {
      type: "integer",
      label: "Max # of Global Suppressions to Return",
      description: "Indicates the max number of global suppressions to return",
      optional: true,
      default: 20,
    },
  },
  async run({ $ }) {
    const constraints = {
      numberOfSupressions: {
        type: "integer",
      },
    };
    if (this.startTime) {
      constraints.startTime = this.getIntegerGtZeroConstraint();
    }
    if (this.endTime) {
      constraints.endTime = {
        numericality: {
          onlyInteger: true,
          greaterThan: this.startTime > 0
            ? this.startTime
            : 0,
          message: "must be positive integer, non zero, greater than `startTime`.",
        },
      };
    }
    if (this.numberOfSupressions) {
      constraints.numberOfSupressions = this.getIntegerGtZeroConstraint();
    }
    const validationResult = validate(
      {
        startTime: this.startTime,
        endTime: this.endTime,
        numberOfSupressions: this.numberOfSupressions,
      },
      constraints,
    );
    this.checkValidationResults(validationResult);
    const resp = await this.sendgrid.listGlobalSuppressions(
      this.startTime,
      this.endTime,
      this.numberOfSuppressions,
    );
    $.export("$summary", "Successfully retrieved global supressions");
    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.
Start Time	`startTime`	`integer`	Refers start of the time range in unix timestamp when an unsubscribe email was created (inclusive)
End Time	`endTime`	`integer`	Refers end of the time range in unix timestamp when an unsubscribe email was created (inclusive)
Max # of Global Suppressions to Return	`numberOfSupressions`	`integer`	Indicates the max number of global suppressions to return