PT EN

Customers

Eventos de Customers: 7 no total. Ver o envelope comum.

account.created

A service account was created.

Recurso: account

Disparar na CLI: gotactl events trigger account.created

Exemplo de payload
{
  "id": "wev_8XwXWh2q7gP6Ksui6Wt8Rew45Yr",
  "type": "account.created",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "account",
    "resource_id": "act_8XwXWh2cdNwsn5LEq2UKWu9b4aq",
    "resource": {
      "type": "account",
      "id": "act_8XwXWh2cdNwsn5LEq2UKWu9b4aq",
      "sequence": 1
    }
  }
}

account.linked

A consumer gained access to an account.

Recurso: account

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_8XwXWh2qyjWcRvtNxUDFJ6z2cab",
  "type": "account.linked",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "account",
    "resource_id": "act_8XwXWh2cdNwsn5LahRimZok9brr",
    "resource": {
      "type": "account",
      "id": "act_8XwXWh2cdNwsn5LahRimZok9brr",
      "sequence": 1
    }
  }
}

account.membership_revoked

A consumer's access to an account was revoked.

Recurso: account

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_8XwXWh2qBZT7QdJP2oeBKsXbbxE",
  "type": "account.membership_revoked",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "account",
    "resource_id": "act_8XwXWh2cdNwsn5LPDx4pAmNx7Cr",
    "resource": {
      "type": "account",
      "id": "act_8XwXWh2cdNwsn5LPDx4pAmNx7Cr",
      "sequence": 1
    }
  }
}

customer.created

A customer was created.

Recurso: customer

Disparar na CLI: gotactl events trigger customer.created

Exemplo de payload
{
  "id": "wev_WNxqQehDFtFd8HshBsiiraSxGaS",
  "type": "customer.created",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "customer",
    "resource_id": "cus_WNxqQehDe7QFfsrfEZKBiY4SGJ6",
    "resource": {
      "type": "customer",
      "id": "cus_WNxqQehDe7QFfsrfEZKBiY4SGJ6",
      "sequence": 1
    }
  }
}

property.created

A property was created.

Recurso: property

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QBY25Lrni4wUBWSWMbmU2CXRMSM",
  "type": "property.created",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "property",
    "resource_id": "prp_QBY25LrnDX7VWLNvLvrZCPqmDMp",
    "resource": {
      "type": "property",
      "id": "prp_QBY25LrnDX7VWLNvLvrZCPqmDMp",
      "sequence": 1
    }
  }
}

property.transferred

A property moved to another customer.

Recurso: property

Não suportado por `events trigger` (use o fluxo normal da API).

Exemplo de payload
{
  "id": "wev_QBY25LrnimTwaDADdguQbHowWMW",
  "type": "property.transferred",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "property",
    "resource_id": "prp_QBY25LrnDX7VWLNvLfbrQckZ85z",
    "resource": {
      "type": "property",
      "id": "prp_QBY25LrnDX7VWLNvLfbrQckZ85z",
      "sequence": 1
    }
  }
}

Receber estes eventos

O seu endpoint de webhook recebe cada um destes eventos num POST com o envelope comum, descrito na tabela abaixo. Verifique a assinatura antes de agir, responda depressa com um código 2xx e faça o trabalho depois: uma resposta lenta ou falhada é enviada outra vez. O mesmo evento pode chegar mais de uma vez, por isso use o seu id para ignorar repetições.

CampoTipoSignificado
idstringIdentificador do evento; o mesmo em todas as tentativas de entrega.
typestringO nome do evento, por exemplo invoice.issued.
api_versionstringA versão da API em que o corpo é escrito.
tenant_idstringA empresa (espaço de trabalho) onde o evento aconteceu.
created_atstring (RFC 3339)Quando o evento foi registado.
request_idstringO pedido à API que causou a mudança, quando houve um; liga ao registo de pedidos.
data.resource_typestringO tipo do recurso que mudou.
data.resource_idstringO identificador desse recurso, para o ler na API.
data.attributesobjectCampos próprios de cada evento; podem não existir. Leia o recurso na API para o estado completo.
data.resource.sequenceintegerConta os eventos do mesmo recurso; ignore um evento que não seja mais recente do que o último que aplicou.

Outras categorias de eventos