Skip to Content

SendGrid Connector

Summary

The Jitterbit Harmony SendGrid Connector establishes access to SendGrid.

The SendGrid connector provides an interface for creating a SendGrid connection, the foundation used for generating instances of SendGrid activities. These activities, once configured, interact with SendGrid through the connection.

The SendGrid connector is accessed from the design component palette's Connectivity tab (see Connectors in Design Component Palette).

Connector Overview

This connector is used to first configure a SendGrid connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific SendGrid connection and its activities are referred to as a SendGrid endpoint:

SendGrid activity types

  • Read: Retrieves object data (by the selected object's id) from SendGrid and is intended to be used as a source in an operation.

  • Query: Queries specified marketing campaign contact data in SendGrid using SendGrid's Segmentation Query Language and is intended to be used as a source in an operation.

  • Upsert: Updates existing contact data or creates new contact data for a marketing campaign in SendGrid and is intended to be used as a target in an operation.

  • Create: Creates object data in SendGrid and is intended to be used as a target in an operation.

  • Update: Updates object data in SendGrid and is intended to be used as a target in an operation.

  • Send: Sends an email from SendGrid and is intended to be used as a target in an operation.

  • Delete: Deletes object data from SendGrid and is intended to be used as a target in an operation.

Note

Verbose logging can be enabled for this connector when it is used with a Private Agent. See Verbose Logging for Connectors for details.

Invoke verbose logging for this connector using this configuration entry:

<logger name="org.jitterbit.connector.verbose.logging.sendgrid" level="DEBUG"/>

Prerequisites and Supported API Versions

The SendGrid connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The SendGrid connector uses the SendGrid v3 API. Refer to the API documentation for information on the schema nodes and fields.