Skip to main content

Airbyte Sendgrid Connector for AI platforms

Project description

Sendgrid

The Sendgrid agent connector is a Python package that equips AI agents to interact with Sendgrid through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.

Connector for the Twilio SendGrid v3 API. Provides read access to marketing campaigns, contacts, lists, segments, single sends, transactional templates, and suppression management (bounces, blocks, spam reports, invalid emails, global suppressions, suppression groups, and suppression group members).

Example questions

The Sendgrid connector is optimized to handle prompts like these.

  • List all marketing contacts
  • Get the details of a specific contact
  • Show me all marketing lists
  • List all transactional templates
  • Show all single sends
  • List all bounced emails
  • Show all blocked email addresses
  • List all spam reports
  • Show all suppression groups
  • How many contacts are in each marketing list?
  • Which single sends were scheduled in the last month?
  • What are the most common bounce reasons?
  • Show me contacts created in the last 7 days

Unsupported questions

The Sendgrid connector isn't currently able to handle prompts like these.

  • Send an email
  • Create a new contact
  • Delete a bounce record
  • Update a marketing list

Installation

uv pip install airbyte-agent-sendgrid

Usage

Connectors can run in open source or hosted mode.

Open source

In open source mode, you provide API credentials directly to the connector.

from airbyte_agent_sendgrid import SendgridConnector
from airbyte_agent_sendgrid.models import SendgridAuthConfig

connector = SendgridConnector(
    auth_config=SendgridAuthConfig(
        api_key="<Your SendGrid API key (generated at https://app.sendgrid.com/settings/api_keys)>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@SendgridConnector.tool_utils
async def sendgrid_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. If your Airbyte client can access multiple organizations, also set organization_id.

This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.

from airbyte_agent_sendgrid import SendgridConnector, AirbyteAuthConfig

connector = SendgridConnector(
    auth_config=AirbyteAuthConfig(
        customer_name="<your_customer_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@agent.tool_plain # assumes you're using Pydantic AI
@SendgridConnector.tool_utils
async def sendgrid_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

Entities and actions

This connector supports the following entities and actions. For more details, see this connector's full reference documentation.

Entity Actions
Contacts List, Get, Context Store Search
Lists List, Get, Context Store Search
Segments List, Get, Context Store Search
Campaigns List, Context Store Search
Singlesends List, Get, Context Store Search
Templates List, Get, Context Store Search
Singlesend Stats List, Context Store Search
Bounces List, Context Store Search
Blocks List, Context Store Search
Spam Reports List
Invalid Emails List, Context Store Search
Global Suppressions List, Context Store Search
Suppression Groups List, Get, Context Store Search
Suppression Group Members List, Context Store Search

Authentication

For all authentication options, see the connector's authentication documentation.

Sendgrid API docs

See the official Sendgrid API reference.

Version information

  • Package version: 0.1.23
  • Connector version: 1.0.3
  • Generated with Connector SDK commit SHA: c5258debd165ab701252c1436d4acfb475bf92b9
  • Changelog: View changelog

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_sendgrid-0.1.23.tar.gz (170.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

airbyte_agent_sendgrid-0.1.23-py3-none-any.whl (195.6 kB view details)

Uploaded Python 3

File details

Details for the file airbyte_agent_sendgrid-0.1.23.tar.gz.

File metadata

  • Download URL: airbyte_agent_sendgrid-0.1.23.tar.gz
  • Upload date:
  • Size: 170.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for airbyte_agent_sendgrid-0.1.23.tar.gz
Algorithm Hash digest
SHA256 7c79638e9702ba6e271e9361aab191f321108cdb21a021f7a415bc1614febfec
MD5 af5b9d45b068e42557330af344e59969
BLAKE2b-256 9eb48c006023423d19a9037535595eafb1fabf8b9215fb1568d93d6bb6446179

See more details on using hashes here.

File details

Details for the file airbyte_agent_sendgrid-0.1.23-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_sendgrid-0.1.23-py3-none-any.whl
Algorithm Hash digest
SHA256 dd836d7241341248625966cc16e3a09086997ebc4570726d70cc5a4660a61b3d
MD5 b1f304211bf78169656a0afbe312269a
BLAKE2b-256 b4ee8d10720a259aca4c6f40b942c2406089f27147f110414fe8e02ad3abba0c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page