PT EN

Collections

Eventos de Collections: 5 no total. Ver o envelope comum.

collection.case_settled

A debt case was settled by payment.

Recurso: collection

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

Exemplo de payload
{
  "id": "wev_WckeV4ejR5CfrWkD7no3pYCkb3V",
  "type": "collection.case_settled",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "collection",
    "resource_id": "col_WckeV4ejR5xHPRH48RRzeFvc7sA",
    "resource": {
      "type": "collection",
      "id": "col_WckeV4ejR5xHPRH48RRzeFvc7sA",
      "sequence": 1
    }
  }
}

collection.cutoff_order_generated

A disconnection order was generated for a debt case.

Recurso: collection

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

Exemplo de payload
{
  "id": "wev_WckeV4ejR5CfzySuRwPEjVJDnyi",
  "type": "collection.cutoff_order_generated",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "collection",
    "resource_id": "col_WckeV4ejR5xHPRH48RRzeFFVwEV",
    "resource": {
      "type": "collection",
      "id": "col_WckeV4ejR5xHPRH48RRzeFFVwEV",
      "sequence": 1
    }
  }
}

collection.payment_plan_created

A payment plan with installments was created.

Recurso: collection

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

Exemplo de payload
{
  "id": "wev_WckeV4ejR5CZnBSDSURQoNHoCSe",
  "type": "collection.payment_plan_created",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "collection",
    "resource_id": "col_WckeV4ejR5xHPRH48RRzekkvgEj",
    "resource": {
      "type": "collection",
      "id": "col_WckeV4ejR5xHPRH48RRzekkvgEj",
      "sequence": 1
    }
  }
}

collection_case.status_changed

A collection case changed status.

Recurso: collection_case

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

Exemplo de payload
{
  "id": "wev_WckeV4ejR5pn6dFAayD5PMm7Kb9",
  "type": "collection_case.status_changed",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "collection_case",
    "resource_id": "col_WckeV4ejR5pn6dFwhjEmgjDk4YF",
    "resource": {
      "type": "collection_case",
      "id": "col_WckeV4ejR5pn6dFwhjEmgjDk4YF",
      "sequence": 1
    }
  }
}

collection_case_dunning.status_changed

A collection case moved through notice, cut-off, disconnection and settlement.

Recurso: collection_case_dunning

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

Exemplo de payload
{
  "id": "wev_WckeV4ejR5pn6dFBKuTM48G4Rj5",
  "type": "collection_case_dunning.status_changed",
  "api_version": "v1",
  "tenant_id": "ten_dMtYBHqoMswJA34fM24koBkTzKe",
  "created_at": "2026-11-19T09:30:00Z",
  "data": {
    "resource_type": "collection_case_dunning",
    "resource": {
      "type": "collection_case_dunning",
      "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