Pular para o conteúdo
Sursa Developers

Eventos · Pessoas e acesso

user.offboarded

Usuário desligado

Um usuário foi desligado: os cartões e as tarefas dele foram transferidos, e a conta foi desativada.

Tipo de objeto
user
Entregue a
Webhooks com a função admin

Payload

Objeto: EventUserOffboarded

  • idstringobrigatório

    ID do evento (evt_…), também enviado como cabeçalho webhook-id. Use-o para descartar entregas duplicadas.

  • typestringobrigatório

    Valores permitidos: user.offboarded

  • created_atstring (date-time)obrigatório

    Quando a alteração aconteceu (UTC).

  • org_idintegerobrigatório
  • api_versionstringobrigatório

    Versão do contrato do esquema data.

  • sequenceinteger

    Número de sequência da entrega dentro do webhook (ausente em um evento de teste).

  • objectWebhookEventObjectobrigatório
  • payloadstringobrigatório

    thin significa sem data: leia o objeto pela API.

    Valores permitidos: fullthin

  • dataobject
    Campos
    • userEventUserobrigatório
    • actor_idinteger | nullobrigatório

      O usuário que realizou a ação; null para uma chave de API da organização ou a própria plataforma.

    • offboardingobjectobrigatório
      Campos
      • transferred_tointegerobrigatório

        Quem recebeu a responsabilidade.

      • api_keys_revokedinteger
      • cardsinteger
      • verifier_ofinteger
      • collectionsinteger
      • sourcesinteger
  • testbooleanobrigatório

    Um evento de teste enviado por POST /v1/webhooks/{webhook_id}/test.

Exemplo de entrega

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "user.offboarded",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "user",
    "id": "11"
  },
  "payload": "full",
  "data": {
    "user": {
      "id": 11,
      "username": "anna",
      "display_name": "Anna Smith",
      "email": "anna@example.com",
      "role": "editor",
      "active": false
    },
    "actor_id": 7,
    "offboarding": {
      "transferred_to": 7,
      "api_keys_revoked": 1,
      "cards": 12,
      "verifier_of": 4,
      "collections": 0,
      "sources": 1
    }
  },
  "test": false
}

Recebimento de eventos

Cada entrega é uma requisição POST com este corpo JSON para a URL do seu webhook. Verifique o cabeçalho webhook-signature (Standard Webhooks) antes de confiar no corpo, responda com um status 2xx em poucos segundos e faça o processamento depois. As entregas a um mesmo webhook mantêm a ordem dos eventos; uma entrega com falha é tentada de novo, com pausas cada vez maiores.

Novos tipos de evento e novos campos podem aparecer a qualquer momento: ignore os tipos e campos que você não conhece.

Os mesmos eventos ficam no feed de eventos por 30 dias →