Pular para o conteúdo
Sursa Developers

Eventos · Fontes e importação

import.document_failed

Falha na importação de um documento

Um documento de uma fonte personalizada não foi importado ou não foi indexado (data.reason é um código neutro).

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

Payload

Objeto: EventImportDocumentFailed

  • idstringobrigatório

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

  • typestringobrigatório

    Valores permitidos: import.document_failed

  • 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
    • sourceEventSourceobrigatório
    • documentobjectobrigatório

      O documento da fonte personalizada; o resultado do documento na API de envio informa o mesmo desfecho.

      Campos
      • external_idstring | nullobrigatório
      • titlestring | null
      • card_idstring | nullobrigatório
    • run_idinteger
    • job_idinteger | null

      O job de indexação ou de exportação.

    • reasonstringobrigatório

      Código neutro do motivo (enumeração extensível: trate um código desconhecido como uma falha genérica). Os valores são códigos de desfecho do documento: content_invalid, file_rejected, too_large, limit_reached, index_failed.

  • testbooleanobrigatório

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

Exemplo de entrega

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "import.document_failed",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "source",
    "id": "5"
  },
  "payload": "full",
  "data": {
    "source": {
      "id": 5,
      "name": "Help center",
      "kind": "custom",
      "collection_id": 3
    },
    "document": {
      "external_id": "kb-article-118",
      "title": "Shipping rates",
      "card_id": null
    },
    "run_id": 902,
    "reason": "content_invalid"
  },
  "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 →