SendGrid

This connector captures data from SendGrid into Estuary collections.

This connector is based on an open-source connector from a third party, with modifications for performance in the Estuary system.

Supported data resources

The following data resources are supported through the SendGrid APIs:

• Campaigns
• Lists
• Contacts
• Stats automations
• Segments
• Single Sends
• Templates
• Global suppression
• Suppression groups
• Suppression group members
• Blocks
• Bounces
• Invalid emails
• Spam reports

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

Prerequisites

• SendGrid API Key for authentication.

Configuration

You configure connectors either in the Estuary 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

Property	Title	Description	Type	Required/Default
/apikey	Sendgrid API key	The value of the SendGrid API Key generated.	string	Required
/start_date	Start Date	The 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.	string	Required

Bindings

Property	Title	Description	Type	Required/Default
/stream	Stream	Resource of your SendGrid project from which collections are captured.	string	Required
/syncMode	Sync Mode	Connection method.	string	Required

Sample

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