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, Search
Lists List, Get, Search
Segments List, Get, Search
Campaigns List, Search
Singlesends List, Get, Search
Templates List, Get, Search
Singlesend Stats List, Search
Bounces List, Search
Blocks List, Search
Spam Reports List
Invalid Emails List, Search
Global Suppressions List, Search
Suppression Groups List, Get, Search
Suppression Group Members List, 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.0
  • Connector version: 1.0.1
  • Generated with Connector SDK commit SHA: bcb024e51bb63dfea8ecdbc59da0966e25d6ed53
  • 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.0.tar.gz (147.3 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.0-py3-none-any.whl (171.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airbyte_agent_sendgrid-0.1.0.tar.gz
  • Upload date:
  • Size: 147.3 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.0.tar.gz
Algorithm Hash digest
SHA256 d6b486f7af676429618f5fcb9b71921cc5651bcb8c6442fb59592d3e381d75e2
MD5 a17b15b3a5a1058f81c3f49d3f954d50
BLAKE2b-256 794653949180f1195c81fd7e0e85b0ec2dce8c8b77eb5c6662ee5be51fef82ff

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_sendgrid-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 69faffb388a6c498f3fc7d71b5825b8c9c86b2a5d2a282e9e69fa6430f99c846
MD5 0f0f822574d1f7c04537b1733ff40751
BLAKE2b-256 9cb93c289215d7dfe4b02a1cb3e9b4df14663e15141f96a3e410e6cdee71141d

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