Novos Endpoints da API: Contatos, Eventos e Webhooks
Acabamos de lançar três novos grupos de recursos na API v2 do Emailit. São eles: Contatos, Eventos e Webhooks. Juntos, eles oferecem controle programático completo sobre sua lista de contatos, monitoramento de eventos e integrações de webhook.
Contatos
A API de Contatos permite criar, consultar, atualizar e excluir contatos no seu workspace. Cada contato possui um endereço de email, nome opcional e campos personalizados, e pode ser inscrito em uma ou mais audiências numa única chamada.
| Endpoint | Descrição |
|---|---|
| Listar Contatos | Lista paginada de todos os contatos |
| Obter Contato | Recuperar um contato por ID ou email |
| Criar Contato | Criar um novo contato e inscrever em audiências |
| Atualizar Contato | Atualizar nome, email, campos personalizados ou status de inscrição |
| Excluir Contato | Excluir um contato e todos os assinantes associados |
Os contatos podem ser consultados pelo ID (con_xxx) ou pelo endereço de email, então você pode usar o identificador que for mais conveniente.
{
"email": "joao@exemplo.com",
"first_name": "João",
"last_name": "Silva",
"custom_fields": { "company": "Acme" },
"audiences": ["aud_2BxFg7KNqr5M..."]
}Eventos
Os eventos são criados automaticamente sempre que algo acontece no seu workspace. Por exemplo, um email é entregue, um contato é criado, um domínio é atualizado, e assim por diante. A API de Eventos oferece acesso somente leitura a esse fluxo de atividades.
| Endpoint | Descrição |
|---|---|
| Listar Eventos | Lista paginada com filtro por tipo e payload de dados opcional |
| Obter Evento | Recuperar um único evento com dados completos |
Você pode filtrar por um ou mais tipos de evento usando valores separados por vírgula, e alternar include_data para controlar se o payload completo é retornado nas respostas de lista.
GET /v2/events?type=email.accepted,email.delivered&include_data=trueWebhooks
Os webhooks permitem receber callbacks HTTP em tempo real sempre que eventos ocorrem. A nova API de Webhooks oferece controle completo. Você pode criar, atualizar, ativar/desativar e excluir endpoints de webhook, tudo através da API.
| Endpoint | Descrição |
|---|---|
| Listar Webhooks | Lista paginada de todos os webhooks |
| Obter Webhook | Recuperar um webhook por ID |
| Criar Webhook | Criar um novo endpoint de webhook |
| Atualizar Webhook | Atualizar URL, eventos ou status ativo |
| Excluir Webhook | Excluir um webhook por ID ou nome |
Você pode se inscrever em tipos específicos de evento ou usar all_events para receber tudo.
{
"name": "Webhook de Produção",
"url": "https://exemplo.com/webhook",
"events": ["email.accepted", "email.delivered", "email.bounced"]
}Há mais de 30 tipos de evento disponíveis abrangendo emails, domínios, audiências, assinantes, contatos, templates, supressões e verificações de email. Veja a lista completa na documentação de Criar Webhook.
Primeiros passos
Todas as três APIs requerem uma chave de API com permissões completas. Acesse a Referência da API para explorar todos os novos endpoints, ou vá direto para a documentação linkada acima.
Blog
As últimas novidades e atualizações, direto da Emailit.
Mantenha-se atualizado com os artigos mais recentes do Blog Emailit.
