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.20
  • Connector version: 1.0.2
  • Generated with Connector SDK commit SHA: eeaf9a603e6c650b89bac7339c63f31ef77f5bcf
  • 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.20.tar.gz (168.7 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.20-py3-none-any.whl (194.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: airbyte_agent_sendgrid-0.1.20.tar.gz
  • Upload date:
  • Size: 168.7 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.20.tar.gz
Algorithm Hash digest
SHA256 7109439a31b0722dfad5b9e9f4bde0509a5b4f6d1dbad1d49e14eb041928b190
MD5 38fbf4d343e242a80b77fb5c909f16e3
BLAKE2b-256 d5d606737e2052566de711384650e523e2831b3d4ac3eb5b9f5f6ffbeac35e73

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_sendgrid-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 380892eddf993f9d3b0979d7c2052bd0d4a5b00aed7763d40ccb308568676adc
MD5 c3ae76f3fbc99eab0b5e5863483378cb
BLAKE2b-256 a22784a7416fd3908b0341fb83829066cd842dd4bf55b9a1d9262b9727c12964

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