Eventos de campanha

Campanhas criadas, alteradas, agendadas, enviadas, canceladas, arquivadas ou excluídas.

campaign.created
campaign.updated
campaign.scheduled
campaign.queued
campaign.sending
campaign.sent
campaign.canceled
campaign.archived
campaign.deleted

campaign.created

Enviado quando uma campanha é criada com Criar uma campanha ou no painel, inclusive quando você duplica uma campanha. As campanhas novas começam como draft.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.created.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre draft.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.created",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00"
    }
  }
}

campaign.updated

Enviado quando o conteúdo ou as configurações de uma campanha mudam, por exemplo com Atualizar uma campanha, ou quando ela volta para draft porque você cancelou o agendamento dela ou a desarquivou no painel. Quando o status mudou, previous_status contém o status antigo.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.updated.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Status atual: draft, scheduled, queued, sending, sent, canceled ou archived.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

Status antes da mudança. Incluído apenas quando o status mudou.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.updated",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "scheduled"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "scheduled"
    }
  }
}

campaign.scheduled

Enviado quando você agenda uma campanha em rascunho com Enviar ou agendar uma campanha e um scheduled_at no futuro, ou no painel. Consulte Testar e agendar.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.scheduled.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre scheduled.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

Status antes da mudança, normalmente draft.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.scheduled",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "scheduled",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "scheduled",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.queued

Enviado quando chega o horário de envio de uma campanha agendada e o Emailit a coloca na fila. campaign.sending vem em seguida, quando o envio começa.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.queued.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre queued.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

Sempre scheduled.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.queued",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "queued",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "scheduled"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "queued",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": "2026-10-02T08:00:00.000000+00:00",
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "scheduled"
    }
  }
}

campaign.sending

Enviado quando o Emailit começa a enviar uma campanha: imediatamente, quando você a envia com Enviar ou agendar uma campanha ou pelo painel, ou quando uma campanha agendada que estava na fila começa.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.sending.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre sending.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

draft quando você enviou a campanha imediatamente, queued para uma campanha agendada.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.sending",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "sending",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:00:03.214000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "sending",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:00:03.214000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.sent

Enviado quando o Emailit termina de criar e colocar na fila um e-mail para cada destinatário inscrito da campanha. Os eventos de entrega, abertura e clique dos e-mails individuais vêm em seguida, à medida que acontecem. Consulte Relatórios de campanha.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.sent.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre sent.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

Sempre sending.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.sent",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "sent",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:04:51.000000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "sending"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "sent",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:04:51.000000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "sending"
    }
  }
}

campaign.canceled

Enviado quando você cancela uma campanha com Cancelar uma campanha. Só campanhas com status draft e sending podem ser canceladas.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.canceled.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre canceled.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

draft ou sending.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.canceled",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "canceled",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "draft"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "canceled",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "draft"
    }
  }
}

campaign.archived

Enviado quando você arquiva uma campanha enviada no painel. Desarquivá-la a devolve ao status draft e envia campaign.updated com previous_status definido como archived.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.archived.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Sempre archived.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

previous_statusstring

Sempre sent.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.archived",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "archived",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": "2026-10-01T10:04:51.000000+00:00",
    "created_at": "2026-09-29T15:10:44.031000+00:00",
    "previous_status": "sent"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "archived",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": "2026-10-01T10:04:51.000000+00:00",
      "created_at": "2026-09-29T15:10:44.031000+00:00",
      "previous_status": "sent"
    }
  }
}

campaign.deleted

Enviado quando uma campanha é excluída com Excluir uma campanha ou no painel. O payload é a campanha como ela era antes de ser excluída.

As requisições de webhook trazem um array JSON de eventos como este; consulte Requisições de webhook.

Campos

event_idstring

ID do evento (evt_…). Uma nova tentativa da requisição traz o mesmo ID, então use-o para ignorar eventos que você já processou. Você também pode consultar o evento com Obter um evento.

typestring

Sempre campaign.deleted.

objectobject

A campanha que o evento descreve. Os campos dela estão listados abaixo.

data.objectobject

O mesmo objeto de novo, no formato que a API de eventos retorna em data.

Objeto de campanha

idstring

ID da campanha (cmp_…).

objectstring

Sempre campaign.

namestring

Nome da campanha.

statusstring

Status que a campanha tinha quando foi excluída.

subjectstring

Linha de assunto, ou uma string vazia se ainda não tiver sido definida.

from_emailstring

Endereço do remetente, ou uma string vazia.

from_namestring

Nome do remetente, ou uma string vazia.

scheduled_atstring | null

Quando o envio da campanha está agendado, ou null.

sent_atstring | null

Quando a campanha foi enviada, ou null.

created_atstring

Quando a campanha foi criada, em ISO 8601 com deslocamento UTC.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "campaign.deleted",
  "object": {
    "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
    "object": "campaign",
    "name": "October product update",
    "status": "draft",
    "subject": "What's new in October",
    "from_email": "news@acme.com",
    "from_name": "Acme",
    "scheduled_at": null,
    "sent_at": null,
    "created_at": "2026-09-29T15:10:44.031000+00:00"
  },
  "data": {
    "object": {
      "id": "cmp_2xLf3Gd8Wr5Mb0Tq6Yn1Kc4Hs9e",
      "object": "campaign",
      "name": "October product update",
      "status": "draft",
      "subject": "What's new in October",
      "from_email": "news@acme.com",
      "from_name": "Acme",
      "scheduled_at": null,
      "sent_at": null,
      "created_at": "2026-09-29T15:10:44.031000+00:00"
    }
  }
}