Pular para o conteúdo
Sursa Developers

Objetos

WebhookDeliveryBody

Corpo da entrega do webhook (a seção webhooks:): o envelope do evento e os campos da entrega. O feed GET /v1/webhook-events retorna o mesmo sem sequence, payload e test.

Campos

  • idstringobrigatório

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

  • typeWebhookEventTypeobrigatório
  • 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

    Payload; a forma dele depende do tipo de evento.

  • testbooleanobrigatório

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

Parte de

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing