Referência
Tipos de evento
Todos os tipos de evento de webhook que o Emailit envia, quando cada um é disparado, qual objeto ele traz e quais tipos o seletor do painel deixa de fora.
Esta é a lista completa dos tipos de evento que o Emailit envia aos webhooks e registra no fluxo de eventos. O data.object de cada evento contém o recurso de que ele trata; a coluna Objeto mostra o valor de object dele. Selecione o nome de um evento para ver o payload completo, quando houver uma página de referência.
Um webhook com All events ativado recebe todos os tipos abaixo. Quando você escolhe os eventos no painel, alguns tipos não aparecem no seletor; eles estão marcados como “Fora do seletor”, e você pode adicioná-los com Atualizar um webhook.
Eventos de e-mail
| Evento | Objeto | Quando é disparado |
|---|---|---|
email.accepted |
email |
Um e-mail enviado pela API ou pelo Compose foi aceito e colocado na fila. Não é enviado para e-mails enviados por SMTP. |
email.scheduled |
email |
Um e-mail da API com scheduled_at no futuro foi armazenado. Inclui scheduled_at. |
email.delivered |
email |
O servidor de e-mail do destinatário aceitou a mensagem. |
email.attempted |
email |
Uma tentativa de entrega falhou temporariamente e será repetida. Enviado a cada tentativa; inclui smtp_code, smtp_enhanced_code e smtp_response. |
email.bounced |
email |
A entrega falhou permanentemente, um relatório de bounce chegou após a entrega ou as novas tentativas se esgotaram. |
email.failed |
email |
O processamento falhou por causa de um erro, não de uma resposta do servidor do destinatário. Raro. |
email.rejected |
email |
O Emailit se recusou a enviar para um destinatário porque o workspace não está verificado. |
email.suppressed |
email |
O destinatário está na lista de supressão, então o e-mail não foi enviado. |
email.held |
email |
O e-mail foi retido e não foi enviado: workspace suspenso, domínio pausado, créditos insuficientes, pontuação de spam de 7 ou mais, ou uma chave de API configurada para reter. Fora do seletor. |
email.canceled |
email |
O e-mail foi cancelado no painel ou pela API. Inclui status e previous_status. Fora do seletor. |
email.received |
email |
Uma mensagem chegou ao seu subdomínio de recebimento. Traz apenas id, from, to, subject e created_at. |
email.complained |
email |
O destinatário marcou o e-mail como spam pelo feedback loop do provedor dele. |
email.loaded |
load |
A imagem de rastreamento foi carregada. Enviado a cada carregamento, não só no primeiro. |
email.clicked |
click |
Um link rastreado foi clicado. Enviado a cada clique; inclui link.url. |
email.unsubscribed |
email |
Um destinatário se descadastrou pelo link ou pela página de descadastro de um e-mail de campanha. Inclui campaign, contact e unsubscribed_at. Fora do seletor. |
email.resubscribed |
email |
Um destinatário se reinscreveu pela página de descadastro. Inclui campaign, contact e resubscribed_at. Fora do seletor. |
Os eventos de status de e-mail (de email.accepted a email.complained, acima) trazem id, from, to, subject, status e meta do e-mail, além de timestamps. Os eventos de clique e de carregamento trazem o próprio id, o email_id, um objeto email aninhado (rcpt_to, mail_from, subject, campaign, meta), o contact correspondente, se houver, ip_address e user_agent. Para saber o que cada status de e-mail significa, consulte Status de e-mail.
Eventos de domínio
| Evento | Objeto | Quando é disparado |
|---|---|---|
domain.created |
domain |
Um domínio de envio foi adicionado. |
domain.updated |
domain |
As configurações de um domínio mudaram, por exemplo o rastreamento ou uma chave de subdomínio. Os resultados da verificação de DNS não enviam este evento. |
domain.deleted |
domain |
Um domínio foi excluído. |
Eventos de lista de contatos e de inscrito
| Evento | Objeto | Quando é disparado |
|---|---|---|
audience.created |
audience |
Uma lista de contatos foi criada. |
audience.updated |
audience |
Uma lista de contatos foi renomeada. |
audience.deleted |
audience |
Uma lista de contatos foi excluída. |
subscriber.created |
subscriber |
Um contato foi adicionado a uma lista de contatos. |
subscriber.updated |
subscriber |
Um inscrito mudou, inclusive ao se descadastrar da lista ou se reinscrever nela. |
subscriber.deleted |
subscriber |
Um contato foi removido de uma lista, inclusive quando o contato foi excluído. |
subscriber.resubscribed |
subscriber |
Um contato descadastrado foi adicionado de novo à lista. Enviado junto com subscriber.updated. Fora do seletor. |
Os objetos de inscrito incluem subscribed, subscribed_at, unsubscribed_at, o audience (id, name) e o contact (id, email, nomes e campos personalizados).
Eventos de contato, template e supressão
| Evento | Objeto | Quando é disparado |
|---|---|---|
contact.created |
contact |
Um contato foi criado. |
contact.updated |
contact |
Os campos, os campos personalizados ou as listas de um contato mudaram. |
contact.deleted |
contact |
Um contato foi excluído. |
template.created |
template |
Foi criado um template ou uma nova versão de template. |
template.updated |
template |
Um template foi editado ou publicado. |
template.deleted |
template |
Um template foi excluído. |
suppression.created |
suppression |
Uma supressão foi adicionada no painel, pela API, por importação de CSV ou por uma automação. |
suppression.updated |
suppression |
O motivo ou a expiração de uma supressão mudou. |
suppression.deleted |
suppression |
Uma supressão foi removida. |
As supressões que o pipeline de entrega adiciona automaticamente após um bounce ou uma reclamação não enviam suppression.created. Para acompanhá-las, escute email.bounced e email.complained.
Eventos de verificação de e-mail
| Evento | Objeto | Quando é disparado |
|---|---|---|
email_verification.created |
email_verification |
Foi solicitada a verificação de um endereço individual. |
email_verification.updated |
email_verification |
Uma verificação terminou e o resultado dela está disponível. |
email_verification_list.created |
email_verification_list |
Uma lista de verificação foi criada. |
email_verification_list.updated |
email_verification_list |
Uma lista terminou de ser processada. Inclui status e stats. |
O seletor do painel também lista email_verification.deleted e email_verification_list.deleted. O Emailit não envia esses eventos.
Eventos de campanha
Os eventos de campanha não aparecem no seletor do painel. Eles chegam aos webhooks com All events ativado, ou você pode adicioná-los pela API. Cada um traz um objeto campaign com id, name, status, subject, from_email, from_name, scheduled_at, sent_at e created_at. As mudanças de status também incluem previous_status.
| Evento | Quando é disparado |
|---|---|
campaign.created |
Uma campanha foi criada. |
campaign.updated |
O conteúdo, o remetente ou os destinatários de uma campanha mudaram. |
campaign.deleted |
Uma campanha foi excluída. |
campaign.scheduled |
Uma campanha foi agendada para um horário futuro. |
campaign.queued |
Uma campanha agendada chegou ao horário de envio e foi colocada na fila. |
campaign.sending |
Uma campanha começou a ser enviada. |
campaign.testing |
Uma campanha entrou no status testing. |
campaign.sent |
Uma campanha terminou de ser enviada. |
campaign.canceled |
Uma campanha foi cancelada. |
campaign.archived |
Uma campanha foi arquivada. |
Nomes de eventos descontinuados
O grupo Deprecated do seletor do painel lista nomes de uma versão mais antiga do Emailit: email.sent, email.opened, email.softfail, email.hardfail, email.error, email.delayed e email.processed. Eles não são mais enviados. Use email.delivered, email.loaded, email.attempted e email.bounced no lugar deles.