Emailit
Documentação Webhooks Eventos

email.accepted

Disparado quando um email é aceito para entrega.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.accepted",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "meta": { "campaign": "welcome-series" },
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

meta object | null

Metadados personalizados anexados ao email.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.scheduled

Disparado quando um email é agendado para entrega futura.

{
  "event_id": "2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.scheduled",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Weekly Digest",
      "meta": { "series": "weekly" },
      "scheduled_at": "2026-02-15T09:00:00.000000+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

meta object | null

Metadados personalizados anexados ao email.

scheduled_at string

Timestamp ISO 8601 para a entrega agendada.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.delivered

Disparado quando um email é entregue com sucesso no servidor de email do destinatário.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.delivered",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "delivered",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre delivered.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da mudança de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.bounced

Disparado quando um email falha permanentemente na entrega (bounce definitivo).

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.bounced",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "bounced",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre bounced.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da mudança de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.attempted

Disparado quando a tentativa de entrega do email resulta em falha temporária.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.attempted",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "attempted",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre attempted.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da alteração de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.failed

Disparado quando um email falha ao ser entregue, geralmente causado por um erro específico durante a entrega.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.failed",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "failed",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre failed.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da mudança de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.rejected

Disparado quando um email foi aceito para entrega mas rejeitado posteriormente.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.rejected",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "rejected",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre rejected.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da mudança de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.suppressed

Disparado quando o destinatário do email está na lista de supressão.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.suppressed",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "suppressed",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre suppressed.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da mudança de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.received

Disparado quando um email recebido é aceito.

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.received",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

created_at string

Timestamp ISO 8601 de quando o email foi recebido.

email.complained

Disparado quando uma reclamação é registrada para este email (por exemplo, marcado como spam).

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.complained",
  "data": {
    "object": {
      "id": "em_4yM2nTvR8oPcX3uZiKeLg7sB",
      "object": "email",
      "from": "sender@example.com",
      "to": "recipient@example.com",
      "subject": "Welcome to Emailit",
      "status": "complained",
      "meta": { "campaign": "welcome-series" },
      "updated_at": "2026-02-11T22:14:33.481927+00:00",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do email.

object string

Sempre email.

from string

Endereço de email do remetente.

to string

Endereço de email do destinatário.

subject string

Linha de assunto do email.

status string

Sempre complained.

meta object | null

Metadados personalizados anexados ao email.

updated_at string

Timestamp ISO 8601 da mudança de status.

created_at string

Timestamp ISO 8601 de quando o email foi criado.

email.clicked

Disparado quando um link dentro de um email é clicado. Inclui detalhes do clique como endereço IP, user agent e a URL que foi clicada.

{
  "event_id": "...",
  "type": "email.clicked",
  "data": {
    "object": {
      "id": "click_4yM2nTvR8oPcX3u...",
      "object": "click",
      "email": {
        "id": "em_...",
        "rcpt_to": "recipient@example.com",
        "mail_from": "sender@example.com",
        "subject": "Welcome",
        "created_at": "...",
        "meta": null
      },
      "link": {
        "id": "link_...",
        "url": "https://example.com/page"
      },
      "ip_address": "203.0.113.42",
      "user_agent": "Mozilla/5.0 ...",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do clique.

object string

Sempre click.

email object

O email que foi clicado.

email.id string

Identificador do email.

email.rcpt_to string

Endereço de email do destinatário.

email.mail_from string

Endereço de email do remetente.

email.subject string

Linha de assunto do email.

email.meta object | null

Metadados personalizados anexados ao email.

link.id string

Identificador do link.

link.url string

A URL que foi clicada.

ip_address string

Endereço IP do clique.

user_agent string

String do user agent do cliente.

created_at string

Timestamp ISO 8601 do clique.

email.loaded

Disparado quando o conteúdo do email é carregado pelo destinatário. Inclui detalhes de rastreamento como endereço IP e user agent.

{
  "event_id": "...",
  "type": "email.loaded",
  "data": {
    "object": {
      "id": "load_4yM2nTvR8oPcX3u...",
      "object": "load",
      "email": {
        "id": "em_...",
        "rcpt_to": "recipient@example.com",
        "mail_from": "sender@example.com",
        "subject": "Welcome",
        "created_at": "...",
        "meta": null
      },
      "ip_address": "203.0.113.42",
      "user_agent": "Mozilla/5.0 ...",
      "created_at": "2026-02-11T22:14:33.481927+00:00"
    }
  }
}

Campos

id string

Identificador único do carregamento.

object string

Sempre load.

email object

O email que foi carregado.

email.id string

Identificador do email.

email.rcpt_to string

Endereço de email do destinatário.

email.mail_from string

Endereço de email do remetente.

email.subject string

Linha de assunto do email.

email.meta object | null

Metadados personalizados anexados ao email.

ip_address string

Endereço IP do carregamento.

user_agent string

String do user agent do cliente.

created_at string

Timestamp ISO 8601 do carregamento.

Localizado por IA