Skip to Content

SendGrid Connector

Summary

The 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 Connections tab (see 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

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Troubleshooting

If you experience issues with the SendGrid connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

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

  5. If using Private Agents, you can check the agent logs for more information.

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.