Pular para o conteúdo
Docs

Eventos de template

Versões de templates criadas, atualizadas, publicadas ou excluídas.

template.created

Enviado quando uma versão de template é criada: com Criar um template, ao importar um template no painel ou ao salvar uma campanha como template. Uma versão criada para um alias novo é publicada imediatamente; confira published_at.

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 template.created.

objectobject

A versão do template 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 template

idstring

ID da versão do template (tem_…).

objectstring

Sempre template.

namestring

Nome do template.

aliasstring

Alias compartilhado por todas as versões do template.

fromstring | null

Remetente padrão.

subjectstring | null

Linha de assunto padrão.

reply_tostring[] | null

Endereços de resposta (Reply-To) padrão.

htmlstring | null

Corpo HTML.

textstring | null

Corpo em texto simples.

editorstring

html, text, dragit ou tiptap.

published_atstring | null

Quando esta versão foi publicada, ou null se ela não for a versão publicada.

created_atstring

Quando a versão foi criada, em ISO 8601 com deslocamento UTC.

updated_atstring

Quando a versão foi atualizada pela última vez.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "template.created",
  "object": {
    "id": "tem_2xKx7M2c9wQe3kHhJ8sVtY1pZ0a",
    "object": "template",
    "name": "Welcome email",
    "alias": "welcome-email",
    "from": "Acme <hello@acme.com>",
    "subject": "Welcome to Acme, {{ first_name }}",
    "reply_to": [
      "support@acme.com"
    ],
    "html": "<h1>Welcome, {{ first_name }}</h1>",
    "text": "Welcome, {{ first_name }}",
    "editor": "html",
    "published_at": "2026-09-30T10:30:00.482119+00:00",
    "created_at": "2026-09-30T10:30:00.482119+00:00",
    "updated_at": "2026-09-30T10:30:00.482119+00:00"
  },
  "data": {
    "object": {
      "id": "tem_2xKx7M2c9wQe3kHhJ8sVtY1pZ0a",
      "object": "template",
      "name": "Welcome email",
      "alias": "welcome-email",
      "from": "Acme <hello@acme.com>",
      "subject": "Welcome to Acme, {{ first_name }}",
      "reply_to": [
        "support@acme.com"
      ],
      "html": "<h1>Welcome, {{ first_name }}</h1>",
      "text": "Welcome, {{ first_name }}",
      "editor": "html",
      "published_at": "2026-09-30T10:30:00.482119+00:00",
      "created_at": "2026-09-30T10:30:00.482119+00:00",
      "updated_at": "2026-09-30T10:30:00.482119+00:00"
    }
  }
}

template.updated

Enviado quando uma versão de template muda com Atualizar um template. A publicação também envia este evento: uma vez para a versão que você publica e uma vez para cada versão do alias que foi despublicada. Use published_at para diferenciá-las.

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 template.updated.

objectobject

A versão do template 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 template

idstring

ID da versão do template (tem_…).

objectstring

Sempre template.

namestring

Nome do template.

aliasstring

Alias compartilhado por todas as versões do template.

fromstring | null

Remetente padrão.

subjectstring | null

Linha de assunto padrão.

reply_tostring[] | null

Endereços de resposta (Reply-To) padrão.

htmlstring | null

Corpo HTML.

textstring | null

Corpo em texto simples.

editorstring

html, text, dragit ou tiptap.

published_atstring | null

Quando esta versão foi publicada, ou null se ela não for a versão publicada.

created_atstring

Quando a versão foi criada, em ISO 8601 com deslocamento UTC.

updated_atstring

Quando a versão foi atualizada pela última vez.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "template.updated",
  "object": {
    "id": "tem_2xKx7M2c9wQe3kHhJ8sVtY1pZ0a",
    "object": "template",
    "name": "Welcome email",
    "alias": "welcome-email",
    "from": "Acme <hello@acme.com>",
    "subject": "Welcome to Acme, {{ first_name }}",
    "reply_to": [
      "support@acme.com"
    ],
    "html": "<h1>Welcome, {{ first_name }}</h1>",
    "text": "Welcome, {{ first_name }}",
    "editor": "html",
    "published_at": "2026-09-30T10:30:00.482119+00:00",
    "created_at": "2026-09-30T10:30:00.482119+00:00",
    "updated_at": "2026-10-01T10:02:14.307000+00:00"
  },
  "data": {
    "object": {
      "id": "tem_2xKx7M2c9wQe3kHhJ8sVtY1pZ0a",
      "object": "template",
      "name": "Welcome email",
      "alias": "welcome-email",
      "from": "Acme <hello@acme.com>",
      "subject": "Welcome to Acme, {{ first_name }}",
      "reply_to": [
        "support@acme.com"
      ],
      "html": "<h1>Welcome, {{ first_name }}</h1>",
      "text": "Welcome, {{ first_name }}",
      "editor": "html",
      "published_at": "2026-09-30T10:30:00.482119+00:00",
      "created_at": "2026-09-30T10:30:00.482119+00:00",
      "updated_at": "2026-10-01T10:02:14.307000+00:00"
    }
  }
}

template.deleted

Enviado quando uma versão de template é excluída com Excluir um template. O payload é a versão como ela era antes de ser excluída. Se ela era a versão publicada, o alias fica sem versão publicada até você publicar outra.

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 template.deleted.

objectobject

A versão do template 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 template

idstring

ID da versão do template (tem_…).

objectstring

Sempre template.

namestring

Nome do template.

aliasstring

Alias compartilhado por todas as versões do template.

fromstring | null

Remetente padrão.

subjectstring | null

Linha de assunto padrão.

reply_tostring[] | null

Endereços de resposta (Reply-To) padrão.

htmlstring | null

Corpo HTML.

textstring | null

Corpo em texto simples.

editorstring

html, text, dragit ou tiptap.

published_atstring | null

Quando esta versão foi publicada, ou null se ela não for a versão publicada.

created_atstring

Quando a versão foi criada, em ISO 8601 com deslocamento UTC.

updated_atstring

Quando a versão foi atualizada pela última vez.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "template.deleted",
  "object": {
    "id": "tem_2xKx7M2c9wQe3kHhJ8sVtY1pZ0a",
    "object": "template",
    "name": "Welcome email",
    "alias": "welcome-email",
    "from": "Acme <hello@acme.com>",
    "subject": "Welcome to Acme, {{ first_name }}",
    "reply_to": [
      "support@acme.com"
    ],
    "html": "<h1>Welcome, {{ first_name }}</h1>",
    "text": "Welcome, {{ first_name }}",
    "editor": "html",
    "published_at": "2026-09-30T10:30:00.482119+00:00",
    "created_at": "2026-09-30T10:30:00.482119+00:00",
    "updated_at": "2026-09-30T10:30:00.482119+00:00"
  },
  "data": {
    "object": {
      "id": "tem_2xKx7M2c9wQe3kHhJ8sVtY1pZ0a",
      "object": "template",
      "name": "Welcome email",
      "alias": "welcome-email",
      "from": "Acme <hello@acme.com>",
      "subject": "Welcome to Acme, {{ first_name }}",
      "reply_to": [
        "support@acme.com"
      ],
      "html": "<h1>Welcome, {{ first_name }}</h1>",
      "text": "Welcome, {{ first_name }}",
      "editor": "html",
      "published_at": "2026-09-30T10:30:00.482119+00:00",
      "created_at": "2026-09-30T10:30:00.482119+00:00",
      "updated_at": "2026-09-30T10:30:00.482119+00:00"
    }
  }
}

Esta página foi útil?

Obrigado pelo feedback.

Obrigado, lemos todas as mensagens.

Esc

Populares

↑↓para navegar↵para abrirEscpara fechar