Anar al contingut
Sursa Developers

Objectes

WebhookDeliveryBody

Cos del lliurament del webhook (la secció webhooks:): l’embolcall de l’esdeveniment i els camps del lliurament. El canal GET /v1/webhook-events retorna el mateix sense sequence, payload ni test.

Camps

  • idstringobligatori

    ID de l’esdeveniment (evt_…), que també s’envia com a capçalera webhook-id. Feu-lo servir per descartar els lliuraments duplicats.

  • typeWebhookEventTypeobligatori
  • created_atstring (date-time)obligatori

    Moment en què es va produir el canvi (UTC).

  • org_idintegerobligatori
  • api_versionstringobligatori

    Versió del contracte de l’esquema de data.

  • sequenceinteger

    Número de seqüència del lliurament dins del webhook (no hi és en un esdeveniment de prova).

  • objectWebhookEventObjectobligatori
  • payloadstringobligatori

    thin vol dir sense data: llegiu l’objecte a través de l’API.

    Valors permesos: fullthin

  • dataobject

    Càrrega útil; la seva forma depèn del tipus d’esdeveniment.

  • testbooleanobligatori

    Esdeveniment de prova enviat per POST /v1/webhooks/{webhook_id}/test.

Forma part de

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing