Novidades3 min de leitura
Novos endpoints da API: contatos, eventos e webhooks
Gerencie contatos, consulte eventos e configure webhooks de forma programática com as novidades da API do Emailit.
GPor George
Acabamos de lançar três novos grupos de recursos na API v2 do Emailit: contatos, eventos e webhooks. Juntos, eles dão a você controle programático total sobre a sua base de contatos, o monitoramento de eventos e as integrações por webhook.
Contatos
A API de contatos permite criar, consultar, atualizar e excluir contatos no seu workspace. Cada contato tem um endereço de e-mail, um nome e campos personalizados opcionais, e pode ser inscrito em uma ou mais listas em uma única chamada.
Endpoint | Descrição |
|---|---|
Lista paginada de todos os contatos | |
Obter um contato pelo ID ou pelo e-mail | |
Criar um novo contato e inscrevê-lo em listas | |
Atualizar nome, e-mail, campos personalizados ou status de descadastro | |
Excluir um contato e todos os inscritos associados |
Os contatos podem ser consultados pelo ID (con_xxx) ou pelo endereço de e-mail, então você usa o identificador que for mais prático.
{
"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: um e-mail é 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 |
|---|---|
Lista paginada com filtro por tipo e payload de dados opcional | |
Obter um único evento com todos os dados |
Você pode filtrar por um ou mais tipos de evento com valores separados por vírgula e usar include_data para definir se o payload completo é retornado nas listagens.
GET /v2/events?type=email.accepted,email.delivered&include_data=trueWebhooks
Os webhooks permitem receber callbacks HTTP em tempo real sempre que ocorrem eventos. A nova API de webhooks dá a você controle total: crie, atualize, ative/desative e exclua endpoints de webhook, tudo pela API.
Endpoint | Descrição |
|---|---|
Lista paginada de todos os webhooks | |
Obter um webhook pelo ID | |
Criar um novo endpoint de webhook | |
Atualizar URL, eventos ou status de ativação | |
Excluir um webhook pelo ID ou pelo nome |
Você pode assinar tipos de evento específicos 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 e-mails, domínios, listas, inscritos, contatos, templates, supressões e verificações de e-mail. Veja a lista completa na documentação de criação de webhook.
Comece agora
As três APIs exigem uma chave de API com acesso total. Acesse a referência da API para explorar todos os novos endpoints ou vá direto para a documentação indicada acima.
