Pular para o conteúdo
Docs

Eventos de inscrito

Contatos adicionados a uma lista de contatos, alterados nela, adicionados de novo a ela ou removidos dela.

subscriber.created

Enviado quando um contato é adicionado a uma lista de contatos com Adicionar um inscrito, ou quando você cria ou atualiza um contato com audiences. Adicionar um contato que tinha se descadastrado da lista envia subscriber.updated e subscriber.resubscribed em vez deste evento.

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

objectobject

O inscrito que o evento descreve. Os campos dele estão listados abaixo.

data.objectobject

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

Objeto de inscrito

idstring

ID do inscrito (sub_…). Um inscrito é a participação de um contato em uma lista de contatos.

objectstring

Sempre subscriber.

subscribedboolean

Se o contato está inscrito na lista.

subscribed_atstring | null

Quando o contato se inscreveu, ou null.

unsubscribed_atstring | null

Quando o contato se descadastrou, ou null.

audienceobject

id e name da lista de contatos.

contactobject

O contato: id, email, first_name, last_name e custom_fields.

created_atstring

Quando o contato foi adicionado à lista, em ISO 8601 com deslocamento UTC.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.created",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": true,
    "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
    "unsubscribed_at": null,
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "created_at": "2026-09-20T14:22:09.418302+00:00"
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": true,
      "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
      "unsubscribed_at": null,
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "created_at": "2026-09-20T14:22:09.418302+00:00"
    }
  }
}

subscriber.updated

Enviado quando um inscrito muda: você o atualiza com Atualizar um inscrito, o contato se descadastra ou se reinscreve, ou um contato que tinha se descadastrado é adicionado de novo à lista. Quando a mudança vem de um descadastro ou de uma reinscrição, previous contém os valores antigos.

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

objectobject

O inscrito que o evento descreve. Os campos dele estão listados abaixo.

data.objectobject

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

Objeto de inscrito

idstring

ID do inscrito (sub_…). Um inscrito é a participação de um contato em uma lista de contatos.

objectstring

Sempre subscriber.

subscribedboolean

Se o contato está inscrito na lista.

subscribed_atstring | null

Quando o contato se inscreveu, ou null.

unsubscribed_atstring | null

Quando o contato se descadastrou, ou null.

audienceobject

id e name da lista de contatos.

contactobject

O contato: id, email, first_name, last_name e custom_fields.

updated_atstring

Quando o inscrito foi atualizado pela última vez, em ISO 8601 com deslocamento UTC.

created_atstring

Quando o contato foi adicionado à lista.

previousobject

Valores antigos, incluídos quando o contato se descadastrou ou se reinscreveu: subscribed e unsubscribed_at. Omitido nas outras mudanças.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.updated",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": false,
    "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
    "unsubscribed_at": "2026-10-01T10:02:14.000000+00:00",
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "updated_at": "2026-10-01T10:02:14.307000+00:00",
    "created_at": "2026-09-20T14:22:09.418302+00:00",
    "previous": {
      "subscribed": true,
      "unsubscribed_at": null
    }
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": false,
      "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
      "unsubscribed_at": "2026-10-01T10:02:14.000000+00:00",
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "updated_at": "2026-10-01T10:02:14.307000+00:00",
      "created_at": "2026-09-20T14:22:09.418302+00:00",
      "previous": {
        "subscribed": true,
        "unsubscribed_at": null
      }
    }
  }
}

subscriber.resubscribed

Enviado quando você adiciona um contato a uma lista de contatos da qual ele tinha se descadastrado, com Adicionar um inscrito. O Emailit também envia subscriber.updated com o mesmo inscrito.

subscriber.resubscribed não está na lista de eventos do painel. Você o recebe nos webhooks que têm all_events ativado ou adicionando-o a events com Atualizar um webhook.

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 subscriber.resubscribed.

objectobject

O inscrito que o evento descreve. Os campos dele estão listados abaixo.

data.objectobject

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

Objeto de inscrito

idstring

ID do inscrito (sub_…). Um inscrito é a participação de um contato em uma lista de contatos.

objectstring

Sempre subscriber.

subscribedboolean

Se o contato está inscrito na lista.

subscribed_atstring | null

Quando o contato se inscreveu, ou null.

unsubscribed_atstring | null

Quando o contato se descadastrou, ou null.

audienceobject

id e name da lista de contatos.

contactobject

O contato: id, email, first_name, last_name e custom_fields.

updated_atstring

Quando o inscrito foi atualizado pela última vez, em ISO 8601 com deslocamento UTC.

created_atstring

Quando o contato foi adicionado à lista.

resubscribedboolean

Sempre true.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.resubscribed",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": true,
    "subscribed_at": "2026-10-01T10:02:14.307000+00:00",
    "unsubscribed_at": null,
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "updated_at": "2026-10-01T10:02:14.307000+00:00",
    "created_at": "2026-09-20T14:22:09.418302+00:00",
    "resubscribed": true
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": true,
      "subscribed_at": "2026-10-01T10:02:14.307000+00:00",
      "unsubscribed_at": null,
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "updated_at": "2026-10-01T10:02:14.307000+00:00",
      "created_at": "2026-09-20T14:22:09.418302+00:00",
      "resubscribed": true
    }
  }
}

subscriber.deleted

Enviado quando um contato é removido de uma lista de contatos: com Excluir um inscrito, quando você altera as audiences de um contato ou quando você exclui o contato. O payload é o inscrito como era antes da remoção.

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

objectobject

O inscrito que o evento descreve. Os campos dele estão listados abaixo.

data.objectobject

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

Objeto de inscrito

idstring

ID do inscrito (sub_…). Um inscrito é a participação de um contato em uma lista de contatos.

objectstring

Sempre subscriber.

subscribedboolean

Se o contato está inscrito na lista.

subscribed_atstring | null

Quando o contato se inscreveu, ou null.

unsubscribed_atstring | null

Quando o contato se descadastrou, ou null.

audienceobject

id e name da lista de contatos.

contactobject

O contato: id, email, first_name, last_name e custom_fields.

updated_atstring

Quando o inscrito foi atualizado pela última vez, em ISO 8601 com deslocamento UTC.

created_atstring

Quando o contato foi adicionado à lista.

JSON
{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "subscriber.deleted",
  "object": {
    "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
    "object": "subscriber",
    "subscribed": true,
    "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
    "unsubscribed_at": null,
    "audience": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "name": "Newsletter"
    },
    "contact": {
      "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
      "email": "ada@example.com",
      "first_name": "Ada",
      "last_name": "Lovelace",
      "custom_fields": {
        "company": "Analytical Engines"
      }
    },
    "updated_at": "2026-09-20T14:22:09.418302+00:00",
    "created_at": "2026-09-20T14:22:09.418302+00:00"
  },
  "data": {
    "object": {
      "id": "sub_2xLj6Fa1Vu8Br3Xg5Cq0Nh7Ow2j",
      "object": "subscriber",
      "subscribed": true,
      "subscribed_at": "2026-09-20T14:22:09.418302+00:00",
      "unsubscribed_at": null,
      "audience": {
        "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
        "name": "Newsletter"
      },
      "contact": {
        "id": "con_2xLf5Jk1Xs7Nc2Ur8Zo3Ld6Pt0a",
        "email": "ada@example.com",
        "first_name": "Ada",
        "last_name": "Lovelace",
        "custom_fields": {
          "company": "Analytical Engines"
        }
      },
      "updated_at": "2026-09-20T14:22:09.418302+00:00",
      "created_at": "2026-09-20T14:22:09.418302+00:00"
    }
  }
}

Esta página foi útil?

Obrigado pelo feedback.

Obrigado, lemos todas as mensagens.

Esc

Populares

↑↓para navegar↵para abrirEscpara fechar