turbot / flowpipe-mod-sendgrid

SendGrid pipeline library for the Flowpipe cloud scripting engine. Automation and workflows to connect SendGrid to the people, systems and data that matters.

SendGrid Mod for Flowpipe

SendGrid pipeline library for Flowpipe, enabling seamless integration of SendGrid services into your workflows.

Documentation

• Pipelines →

Getting started

Requirements

Docker daemon must be installed and running. Please see Install Docker Engine for more information.

Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:

brew tap turbot/tap
brew install flowpipe

Clone:

git clone https://github.com/turbot/flowpipe-mod-sendgrid.git
cd flowpipe-mod-sendgrid

Credentials

By default, the following environment variables will be used for authentication:

• SENDGRID_API_KEY

You can also create credential resources in configuration files:

vi ~/.flowpipe/config/sendgrid.fpc

credential "sendgrid" "sendgrid_cred" {
  api_key = "SG.R7...."
}

For more information on credentials in Flowpipe, please see Managing Credentials.

Usage

List pipelines:

flowpipe pipeline list

Run a pipeline:

flowpipe pipeline run send_mail

You can pass in pipeline arguments as well:

flowpipe pipeline run get_contact_by_id --arg contact_id=ZGkrHSypTsudrGkmdpJJ

To use a specific credential, specify the cred pipeline argument:

flowpipe pipeline run get_contact_by_id --arg contact_id=ZGkrHSypTsudrGkmdpJJ --arg cred=sendgrid_cred

For more examples on how you can run pipelines, please see Run Pipelines.

Configuration

No additional configuration is required.

Open Source & Contributing

This repository is published under the Apache 2.0 license. Please see our code of conduct. We look forward to collaborating with you!

Flowpipe is a product produced from this open source software, exclusively by Turbot HQ, Inc. It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our Open Source FAQ.

Get Involved

Join #flowpipe on Slack →

Want to help but not sure where to start? Pick up one of the help wanted issues:

• Flowpipe
• SendGrid Mod