Quais são os diferentes formatos de Webhooks?
Eventos Apoiados: Atualmente apoiamos Webhook em uma série de eventos, que são:
Event | Description |
Sent | Message has been sent successfully |
Dropped | Message got dropped |
Bounced | Message has hard bounce |
Opened | Message got opened |
Clicked | Recipient clicked a link in the message; will only occur when click tracking is enabled |
Unsubscribed | Recipient Unsubscribed |
Invalid | Syntactically incorrect email ids |
Abuse | Recipient marked the message as spam |
Por que não é possível verificar o meu Webhook ou o URL de retorno da chamada?
Quando você adiciona a URL, a Netcore Email API faz um teste HTTP(s) POST.
Se o POST de dados for aceito com sucesso pelo seu servidor, então o Netcore Email API verifica e salva o URL do webhook
Dados do Evento
Abaixo estão os dados de exemplo para cada evento que lhe mostrarão os campos reais que foram devolvidos no(s) HTTP(s) POST:
Glossary
Parameters Used | Supported by Events | Description |
TRANSID | All | All assigns a Unique Transaction ID for each and every email which were sent |
All | Recipient’s Email ID | |
EVENT | All | Type of Event: sent/ dropped/ invalid/ bounced/ opened/ clicked/ unsubscribed/ abuse |
RESPONSE | sent/ dropped/invalid/ bounce | Response received from the end server like Delivery Logs, Bounce reason, reason for drop(blacklisted user / already unsubscribed) |
X-APIHEADER | All | Information passed by you in the X-APIHEADER, during the time of email sent |
TIMESTAMP | All | Unix Timestamp of the occurrence of the event |
USERAGENT | opened/ clicked/ unsubscribed/abuse | User agent contains the detailed information about the browser from where a specific event in initiated. |
IPADDRESS | opened/ clicked/unsubscribed/abuse | IP address of the device from where the recipient has responded. |
Enviado para
O e-mail foi entregue com sucesso no servidor receptor:
Amostra de dados do gancho web enviado
Um exemplo do JSON completo que seria POSTED ao seu webhook URL é:
[
{
"TRANSID":"14652378013752608",
"RCPTID":"0",
"RESPONSE":"smtp;250 2.0.0 OK 1465276276 mo3si31128106wjb.147 – gsmtp",
"EMAIL":"[email protected]",
"TIMESTAMP":"1465276276",
"CLIENTID":"10001",
"FROMADDRESS":"[email protected]",
"EVENT":"sent",
"MSIZE":"1216"
}
]
Caiu
Os utilizadores que já anularam a sua inscrição no passado ou que já se encontram na lista negra por causa de reclamações hard bounce/Spam, serão tratados como se tivessem sido eliminados. E, nenhuma outra comunicação por e-mail é permitida nestes tipos de ids.
[
{
“TRANSID”:”14652378021238672″,
“RCPTID”:”0″,
“RESPONSE”:”Recipient Dropped :: status not confirmed”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465300547″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”dropped”,
“MSIZE”:”575″
}
]
Inválido
Todos os pedidos API com ids sintaticamente incorretos serão tratados como Inválidos e nenhum processamento adicional será feito em tais ids. Você pode capturar todos esses eventos inválidos em tempo real e tentar corrigi-los offline.
[
{
“TRANSID”:”14652378021198302″,
“RCPTID”:””,
“RESPONSE”:”Invalid Email Address”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465300638″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”invalid”,
“MSIZE”:”16900″
}
]
Saltou
O servidor receptor não poderia ou não aceitaria mensagens devido a múltiplas razões como, por exemplo, o servidor receptor não ser alcançável, o id de e-mail não existir, etc. Todas essas razões fazem parte do Hard Bounce, o que levará à criação de uma lista negra desse id de e-mail no sistema Netcore Email API . Existem outros conjuntos de bounces que são tratados como Soft Bounce, por exemplo, caixa de correio cheia. Estes são ressaltos temporários.
Ressalto Difícil
[
{
“TRANSID”:”14652378014624064″,
“RCPTID”:”0″,
“RESPONSE”:”smtp;550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient’s email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/answer/6596 z130si23626456iod.1″,
“BOUNCE_TYPE”:”HARDBOUNCE”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465277622″,
“BOUNCE_REASONID”:”77″,
“CLIENTID”:”10001″,
“BOUNCE_REASON”:”email account that you tried to reach does not exist”,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”bounced”,
“MSIZE”:”10″,
“USERAGENT”:”10″
}
]
Pulo Suave
[
{
“TRANSID”:”14652378014624064″,
“RCPTID”:”0″,
“RESPONSE”:”smtp;550 5.1.1 Mail box full”,
“BOUNCE_TYPE”:”SOFTBOUNCE”,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465277622″,
“BOUNCE_REASONID”:”1099″,
“CLIENTID”:”10001″,
“BOUNCE_REASON”:”mail box full for the account you reached”,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”bounced”,
“MSIZE”:”10″,
“USERAGENT”:”10″
}
]
Aberto em
O destinatário abriu o e-mail.
[
{
“TRANSID”:”14652378013752608″,
“RCPTID”:”0″,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465276362″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”opened”,
“MSIZE”:”1216″,
“USERAGENT”:”Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0 (via ggpht.com GoogleImageProxy)”,
“IPADDRESS”:”64.233.173.70″
}
]
Clicado
O destinatário clicou em um link na mensagem.
[
{
“TRANSID”:”14652378018802172″,
“RCPTID”:”[email protected]”,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465299696″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”clicked”,
“MSIZE”:”19379″,
“USERAGENT”:”Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36″,
“URL”:”https://www.pepipost.com”,
“IPADDRESS”:”11.11.11.16″
}
]
Não inscrito
O destinatário clicou no link de gerenciamento de cancelamento.
[
{
“TRANSID”:”14652378014983009″,
“RCPTID”:”4″,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465278512″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”unsubscribed”,
“MSIZE”:”1718″,
“USERAGENT”:”Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36″,
“IPADDRESS”:”19.16.11.11″
}
]
Abuso
Destinatário que marcou o e-mail como spam
[
{
“TRANSID”:”14652378014983009″,
“RCPTID”:”4″,
“RESPONSE”:””,
“EMAIL”:”[email protected]”,
“TIMESTAMP”:”1465278512″,
“CLIENTID”:”10001″,
“FROMADDRESS”:”[email protected]”,
“EVENT”:”abuse”,
“MSIZE”:”1718″,
“USERAGENT”:”Mozilla/5.0 (X11; Linux i686) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/48.0.2564.116 Safari/537.36″,
“IPADDRESS”:”19.16.11.11″
}
]
Posso ver os lotes do Webhook com falha?
Não
Updated about 3 years ago