Skip to main content

SendGrid

This connector captures data from SendGrid into Flow collections.

It is available for use in the Flow web application. For local development or open-source workflows, ghcr.io/estuary/source-sendgrid:dev provides the latest version of the connector as a Docker image. You can also follow the link in your browser to see past image versions.

This connector is based on an open-source connector from a third party, with modifications for performance in the Flow system. You can find their documentation here, but keep in mind that the two versions may be significantly different.

Supported data resources

The following data resources are supported through the SendGrid APIs:

By default, each resource is mapped to a Flow collection through a separate binding.

Prerequisites

  • SendGrid API Key for authentication.

Configuration

You configure connectors either in the Flow web app, or by directly editing the catalog specification file. See connectors to learn more about using connectors. The values and specification sample below provide configuration details specific to the SendGrid source connector.

Properties

Endpoint

PropertyTitleDescriptionTypeRequired/Default
/apikeySendgrid API keyThe value of the SendGrid API Key generated.stringRequired
/start_dateStart DateThe date from which you'd like to replicate data for SendGrid API, in the format YYYY-MM-DDT00:00:00Z. Any data before this date will not be replicated.stringRequired

Bindings

PropertyTitleDescriptionTypeRequired/Default
/streamStreamResource of your SendGrid project from which collections are captured.stringRequired
/syncModeSync ModeConnection method.stringRequired

Sample


captures:
${PREFIX}/${CAPTURE_NAME}:
endpoint:
connector:
image: ghcr.io/estuary/source-sendgrid:dev
config:
apikey: <secret>
start_date: 2017-01-25T00:00:00Z
bindings:
- resource:
stream: blocks
syncMode: incremental
target: ${PREFIX}/blocks
{...}