Eventos de lista de contatos

Listas de contatos criadas, atualizadas ou excluídas.

audience.created
audience.updated
audience.deleted

audience.created

Enviado quando uma lista de contatos é criada, por exemplo com Criar uma lista de contatos.

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

objectobject

A lista de contatos 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 lista de contatos

idstring

ID da lista de contatos (aud_…).

objectstring

Sempre audience.

namestring

Nome da lista de contatos.

created_atstring

Quando a lista de contatos foi criada, em ISO 8601 com deslocamento UTC.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "audience.created",
  "object": {
    "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
    "object": "audience",
    "name": "Newsletter",
    "created_at": "2026-10-01T10:02:11.583000+00:00"
  },
  "data": {
    "object": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "object": "audience",
      "name": "Newsletter",
      "created_at": "2026-10-01T10:02:11.583000+00:00"
    }
  }
}

audience.updated

Enviado quando uma lista de contatos muda, por exemplo quando você a renomeia com Atualizar uma lista de contatos. Mudanças nos inscritos enviam eventos de inscrito.

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

objectobject

A lista de contatos 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 lista de contatos

idstring

ID da lista de contatos (aud_…).

objectstring

Sempre audience.

namestring

Nome da lista de contatos.

updated_atstring

Quando a lista de contatos foi atualizada pela última vez, em ISO 8601 com deslocamento UTC.

created_atstring

Quando a lista de contatos foi criada.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "audience.updated",
  "object": {
    "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
    "object": "audience",
    "name": "Monthly newsletter",
    "updated_at": "2026-10-01T10:02:14.307000+00:00",
    "created_at": "2026-09-15T12:00:41.305000+00:00"
  },
  "data": {
    "object": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "object": "audience",
      "name": "Monthly newsletter",
      "updated_at": "2026-10-01T10:02:14.307000+00:00",
      "created_at": "2026-09-15T12:00:41.305000+00:00"
    }
  }
}

audience.deleted

Enviado quando uma lista de contatos é excluída, por exemplo com Excluir uma lista de contatos. O payload é a lista 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 audience.deleted.

objectobject

A lista de contatos 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 lista de contatos

idstring

ID da lista de contatos (aud_…).

objectstring

Sempre audience.

namestring

Nome da lista de contatos.

updated_atstring

Quando a lista de contatos foi atualizada pela última vez, em ISO 8601 com deslocamento UTC.

created_atstring

Quando a lista de contatos foi criada.

JSON

{
  "event_id": "evt_2xLc9Rr4Tn6Wb1Qm8Ks3Vf0Hd7a",
  "type": "audience.deleted",
  "object": {
    "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
    "object": "audience",
    "name": "Monthly newsletter",
    "updated_at": "2026-09-30T08:14:02.771000+00:00",
    "created_at": "2026-09-15T12:00:41.305000+00:00"
  },
  "data": {
    "object": {
      "id": "aud_2xLi5Ez0Ut7Aq2Wf4Bp9Mg6Nv1i",
      "object": "audience",
      "name": "Monthly newsletter",
      "updated_at": "2026-09-30T08:14:02.771000+00:00",
      "created_at": "2026-09-15T12:00:41.305000+00:00"
    }
  }
}