SendGrid

Visão geral

SendGrid é uma plataforma de entrega de e-mail baseada em nuvem que oferece serviços de e-mail transacional e de marketing, com APIs para integração, análises e escalabilidade. Com a integração SendGrid no SquadOS, seus agentes podem enviar e-mails, gerenciar contatos e listas, criar templates dinâmicos e monitorar métricas de entrega — tudo de forma automatizada.

• Site oficial: https://sendgrid.com/
• Documentação na Composio: docs.composio.dev/toolkits/sendgrid

Autenticação

Esta ferramenta utiliza chave de API (API_KEY) para conectar.

Você vai precisar dos seguintes campos:

Campo	Obrigatório	Descrição
api_key	Sim	Chave de API da sua conta SendGrid, usada para autenticar todas as requisições.

Como obter a credencial

1. Acesse app.sendgrid.com e faça login na sua conta.
2. No menu lateral, vá em Settings → API Keys.
3. Clique em Create API Key.
4. Escolha um nome descritivo (ex.: squados-integration) e selecione as permissões necessárias — para uso completo, escolha Full Access; para uso restrito, selecione apenas Mail Send e as permissões de Marketing Campaigns.
5. Clique em Create & View e copie a chave exibida. Ela só é mostrada uma vez — guarde-a em local seguro.

Dica

Use uma chave dedicada para o SquadOS com as permissões mínimas necessárias. O SendGrid permite revogar chaves individualmente sem afetar outras integrações.

Como conectar no SquadOS

1. Acesse Ferramentas no menu lateral (/admin/tools).
2. Abra a aba Disponíveis e procure por SendGrid.
3. Clique no card para abrir o modal de detalhes e em Conectar.
4. Você é levado para a página de conexão segura hospedada pela Composio, onde informa a chave de API obtida acima.
5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

Ações disponíveis

Nota

Esta integração expõe 364 ações no total. Abaixo estão as principais; a lista completa está na documentação da Composio.

Enviar e-mail com Twilio SendGrid

SENDGRID_SEND_EMAIL_WITH_TWILIO_SEND_GRID

Envia e-mails usando a API v3 do SendGrid. Suporta destinatários múltiplos, anexos, templates dinâmicos, agendamento e configurações avançadas de rastreamento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
personalizations	array	Sim	Array de objetos de personalização, cada um define destinatários e metadados do e-mail.
from__email	string	Não	Endereço de e-mail do remetente. Deve ser um remetente verificado na conta SendGrid.
from__name	string	Não	Nome exibido junto ao endereço do remetente.
subject	string	Não	Linha de assunto global do e-mail. Pode ser sobrescrita em personalizations.
content	array	Não	Array de objetos com o conteúdo do e-mail e tipo MIME. Deve incluir ao menos um tipo MIME.
template_id	string	Não	ID de um template de e-mail. Templates dinâmicos começam com d-.
attachments	array	Não	Array de objetos de anexo. Cada um deve conter o conteúdo em Base64, tipo e nome do arquivo.
send_at	integer	Não	Timestamp Unix para agendamento do envio. Máximo de 72 horas no futuro.
batch_id	string	Não	ID de lote para envios agrupados, permitindo cancelar ou pausar a entrega.
categories	array	Não	Array de nomes de categorias para agrupamento de mensagens.
asm__group__id	integer	Não	ID do grupo de supressão de descadastramento associado ao e-mail.
reply__to__email	string	Não	Endereço de e-mail para respostas.
ip_pool_name	string	Não	Nome do pool de IPs dedicados para o envio.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar template transacional

SENDGRID_CREATE_A_TRANSACTIONAL_TEMPLATE

Cria um novo template de e-mail transacional no SendGrid. Templates do tipo dynamic usam sintaxe Handlebars (ex.: {{nome}}); templates legacy usam tags de substituição (ex.: -nome-). Cada conta pode criar até 300 templates.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do novo template transacional.
generation	string	Não	Tipo do template: legacy (tags de substituição) ou dynamic (Handlebars). Padrão: legacy.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar versão de template transacional

SENDGRID_CREATE_A_NEW_TRANSACTIONAL_TEMPLATE_VERSION

Adiciona uma nova versão a um template transacional existente, incluindo conteúdo HTML, texto simples e linha de assunto. Suporta sintaxe Handlebars para templates dinâmicos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
template_id	string	Sim	ID do template transacional ao qual a versão será adicionada. Templates dinâmicos começam com d-.
name	string	Sim	Nome desta versão do template.
subject	string	Sim	Linha de assunto do e-mail. Suporta substituições Handlebars.
html_content	string	Não	Conteúdo HTML do template. Máximo de 1 MB.
plain_content	string	Não	Conteúdo em texto simples. Se omitido e generate_plain_content for verdadeiro, é gerado automaticamente.
active	integer	Não	Define 1 para tornar esta versão ativa imediatamente.
editor	string	Não	Tipo de editor: code ou design.
test_data	string	Não	JSON com dados de teste para templates dinâmicos.
generate_plain_content	boolean	Não	Se verdadeiro, o conteúdo em texto simples é sempre gerado a partir do HTML.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Ativar versão de template

SENDGRID_ACTIVATE_TEMPLATE_VERSION

Ativa uma versão específica de um template transacional, tornando-a a versão padrão usada no envio de e-mails. Somente uma versão pode estar ativa por template ao mesmo tempo.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
template_id	string	Sim	ID do template transacional. Templates dinâmicos começam com d-.
version_id	string	Sim	UUID da versão do template a ser ativada.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Editar template transacional

SENDGRID_EDIT_A_TRANSACTIONAL_TEMPLATE

Atualiza o nome de um template transacional existente. Para modificar o conteúdo do template (HTML, assunto), use a API de versões de templates.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
template_id	string	Sim	ID único do template transacional a editar.
name	string	Não	Novo nome para o template.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar template transacional

SENDGRID_RETRIEVE_A_SINGLE_TRANSACTIONAL_TEMPLATE

Recupera os detalhes de um template transacional pelo seu ID, incluindo todas as versões associadas e qual versão está ativa no momento.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
template_id	string	Sim	ID único do template transacional a recuperar. Templates dinâmicos começam com d-.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Adicionar ou atualizar contato

SENDGRID_ADD_OR_UPDATE_A_CONTACT

Adiciona ou atualiza contatos no Marketing Campaigns do SendGrid de forma assíncrona. Contatos são identificados por e-mail, phone_number_id, external_id ou anonymous_id. Máximo de 30.000 contatos ou 6 MB por requisição.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
contacts	array	Sim	Array de objetos de contato. Cada contato deve incluir ao menos um identificador (email, phone_number_id, external_id ou anonymous_id). Campos opcionais: first_name, last_name, city, country, etc.
list_ids	array	Não	Array de IDs de listas (UUIDs) às quais os contatos serão adicionados.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Buscar contato por ID

SENDGRID_GET_A_CONTACT_BY_ID

Recupera os detalhes completos de um único contato pelo seu ID único no Marketing Campaigns do SendGrid, incluindo campos padrão e personalizados.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
id	string	Sim	Identificador único (UUID) do contato a recuperar.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Excluir contatos

SENDGRID_DELETE_CONTACTS

Exclui contatos da conta do Marketing Campaigns do SendGrid. Operação assíncrona e irreversível. Informe ids (UUIDs separados por vírgula) para excluir contatos específicos, ou delete_all_contacts como "true" para excluir todos os contatos.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
ids	string	Não	Lista de IDs de contatos (UUIDs) separados por vírgula a serem excluídos. Use este campo OU delete_all_contacts, nunca ambos.
delete_all_contacts	string	Não	Defina como "true" para excluir TODOS os contatos da conta. Irreversível. Use este campo OU ids, nunca ambos.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Exportar contatos

SENDGRID_EXPORT_CONTACTS

Inicia um job assíncrono para exportar contatos do Marketing Campaigns em formato CSV ou JSON. Após iniciar o job, use o endpoint de status de exportação para verificar o progresso e obter as URLs de download (válidas por 72 horas).

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
file_type	string	Não	Formato de exportação: csv ou json.
list_ids	array	Não	IDs das listas a exportar. Se omitido junto com segment_ids, exporta todos os contatos.
segment_ids	array	Não	IDs dos segmentos a exportar.
max_file_size	integer	Não	Tamanho máximo de cada arquivo exportado em MB (padrão: 5000 MB).
notifications__email	boolean	Não	Se verdadeiro, envia e-mail com o link de download quando a exportação estiver pronta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar lista de contatos

SENDGRID_CREATE_A_LIST

Cria uma nova lista de contatos no Marketing Campaigns do SendGrid. Os nomes de listas devem ser únicos na conta. Após criar a lista, use a ação de adicionar contatos para preenchê-la.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da lista de contatos. Deve ser único entre todas as listas da conta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar segmento

SENDGRID_CREATE_A_SEGMENT

Cria um novo segmento no banco de dados de contatos do SendGrid (Marketing Campaigns legado). Segmentos agrupam contatos com base em condições específicas para campanhas de e-mail direcionadas. Suporta operadores como eq, ne, contains, gt, lt e combinações com and/or.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome único para o segmento.
conditions	array	Sim	Array de objetos de condição que definem os critérios de associação ao segmento. Cada condição deve ter field, operator e value.
list_id	integer	Não	ID de uma lista existente da qual criar o segmento. Se omitido, o segmento é criado a partir do banco de contatos principal.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todos os envios únicos

SENDGRID_GET_ALL_SINGLE_SENDS

Recupera a lista de Single Sends com informações resumidas, incluindo seus IDs. Para detalhes completos de um Single Send específico, use seu ID na ação correspondente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
page_size	integer	Não	Número de itens por página.
page_token	string	Não	Token para paginação.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar envio único (Single Send)

SENDGRID_CREATE_SINGLE_SEND

Cria um rascunho de Single Send sem necessidade de um template. O campo send_at pré-preenche a data no painel do SendGrid, mas o agendamento efetivo deve ser feito pelo endpoint de agendamento ou pela interface do SendGrid.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do Single Send. Deve ser único.
email__config__subject	string	Não	Linha de assunto do e-mail. Não use junto com email__config__design__id.
email__config__html__content	string	Não	Conteúdo HTML do Single Send.
email__config__plain__content	string	Não	Conteúdo em texto simples.
email__config__sender__id	integer	Não	ID do remetente verificado.
email__config__suppression__group__id	integer	Não	ID do grupo de supressão para descadastramento.
send__to__list__ids	array	Não	IDs das listas de destinatários.
send__to__segment__ids	array	Não	IDs dos segmentos de destinatários.
send__to__all	boolean	Não	Defina como true para enviar a todos os contatos.
categories	array	Não	Categorias a associar ao Single Send.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Recuperar todos os envios agendados

SENDGRID_RETRIEVE_ALL_SCHEDULED_SENDS

Retorna detalhes de envios agendados cancelados ou pausados. Apenas envios que possuem um batch_id são listados; envios agendados sem batch_id via /mail/send não aparecem neste endpoint.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar identidade de remetente

SENDGRID_CREATE_A_SENDER_IDENTITY

Cria uma nova identidade de remetente no SendGrid. Uma identidade de remetente é necessária para enviar e-mails e representa as informações de “De” que os destinatários verão. É possível criar até 100 identidades de remetente por conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
nickname	string	Sim	Nome amigável para identificar esta identidade no painel SendGrid. Não é exibido aos destinatários.
from__name	string	Sim	Nome exibido no campo “De” dos e-mails enviados.
from__email	string	Sim	Endereço de e-mail do campo “De”. Precisa ser verificado.
reply__to__email	string	Sim	Endereço de e-mail para onde as respostas dos destinatários serão enviadas.
address	string	Sim	Endereço físico do remetente (obrigatório para conformidade com CAN-SPAM).
city	string	Sim	Cidade do remetente.
country	string	Sim	País do remetente.
state	string	Não	Estado ou província do remetente.
zip	string	Não	CEP ou código postal do remetente.
address_2	string	Não	Complemento do endereço.
reply__to__name	string	Não	Nome para o endereço de resposta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Listar todas as identidades de remetente

SENDGRID_GET_ALL_SENDER_IDENTITIES

Recupera a lista de todas as identidades de remetente criadas na conta.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar grupo de supressão

SENDGRID_CREATE_A_NEW_SUPPRESSION_GROUP

Cria um novo grupo de supressão (grupo de descadastramento) para permitir que destinatários optem por não receber tipos específicos de e-mails. É possível criar até 200 grupos de supressão por conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Não	Nome do grupo de supressão. Visível aos destinatários nas preferências de e-mail.
description	string	Não	Descrição breve do tipo de e-mails cobertos pelo grupo. Visível aos destinatários.
is_default	boolean	Não	Se verdadeiro, este grupo será o padrão de descadastramento.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Adicionar endereços a um grupo de supressão

SENDGRID_ADD_SUPPRESSIONS_TO_A_SUPPRESSION_GROUP

Adiciona endereços de e-mail a um grupo de descadastramento. Se o grupo foi excluído ou não existe, os endereços são adicionados à lista de supressão global.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
group_id	string	Sim	ID do grupo de descadastramento ao qual os endereços serão adicionados.
recipient_emails	array	Sim	Lista de endereços de e-mail a adicionar ao grupo de supressão.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Adicionar endereços à supressão global

SENDGRID_ADD_TO_GLOBAL_SUPPRESSIONS_GROUP

Adiciona um ou mais endereços de e-mail ao grupo de supressão global. E-mails adicionados a este grupo não receberão mais nenhum e-mail da conta SendGrid.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
recipient_emails	array	Sim	Lista de endereços de e-mail válidos a adicionar à supressão global. Pelo menos um endereço é obrigatório.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar chaves de API

SENDGRID_CREATE_API_KEYS

Cria uma nova chave de API SendGrid com as permissões especificadas. A chave de API é exibida apenas uma vez na resposta — guarde-a em local seguro. Limite: 100 chaves por conta.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
name	string	Sim	Nome da chave de API, usado para identificá-la no painel SendGrid.
scopes	array	Não	Lista de escopos de permissão (ex.: mail.send, alerts.read). Se omitido, a chave recebe acesso total.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter URL de download de atividade de e-mail em CSV

SENDGRID_DOWNLOAD_CSV

Recupera uma URL pré-assinada do S3 para download de um arquivo CSV com dados de atividade de e-mail (até 1 milhão de eventos, últimos 30 dias). Requer plano Pro/Premier com o complemento de histórico adicional de atividade de e-mail.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
download_uuid	string	Sim	UUID único para a requisição de download do CSV, fornecido pelo SendGrid por e-mail quando o arquivo está pronto.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Criar campanha

SENDGRID_CREATE_A_CAMPAIGN

Cria uma campanha de marketing (API legado do Marketing Campaigns). Requer um assunto, ID do remetente e conteúdo antes do envio ou agendamento. Listas e segmentos de destinatários podem ser definidos na criação ou posteriormente.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
title	string	Sim	Título de exibição da campanha no Marketing Campaigns.
subject	string	Não	Assunto do e-mail que os destinatários verão.
sender_id	integer	Não	ID da identidade de remetente verificada.
html_content	string	Não	Conteúdo HTML da campanha de marketing.
plain_content	string	Não	Conteúdo em texto simples da campanha.
list_ids	array	Não	IDs das listas de destinatários.
segment_ids	array	Não	IDs dos segmentos de destinatários. Limite de 10 segmentos.
categories	array	Não	Categorias associadas à campanha.
suppression_group_id	integer	Não	ID do grupo de supressão para opções de descadastramento.
ip_pool	string	Não	Nome do pool de IPs para envio da campanha.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Enviar campanha

SENDGRID_SEND_A_CAMPAIGN

Envia imediatamente uma campanha de marketing existente para seus destinatários configurados. A campanha deve estar no status draft e ter assunto, sender_id e ao menos um list_id ou segment_id configurado.

Parâmetros de entrada

Nome	Tipo	Obrigatório	Descrição
campaign_id	integer	Sim	Identificador numérico único da campanha a enviar. A campanha deve estar no status draft.

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.

Obter informações da conta

SENDGRID_GET_A_USER_S_ACCOUNT_INFORMATION

Recupera os detalhes da conta SendGrid do usuário autenticado, incluindo o tipo de conta (ex.: free, paid) e a pontuação de reputação do remetente (0-100).

Saída

Nome	Tipo	Obrigatório	Descrição
data	string	Sim	Dados retornados pela execução da ação.
error	string	Não	Mensagem de erro caso a execução tenha falhado.
successful	boolean	Sim	Indica se a ação foi executada com sucesso.