Hoppa till innehållet
Sursa Developers

Objekt

WebhookDeliveryBody

Brödtext i en webhookleverans (avsnittet webhooks:): händelsens kuvert och leveransfälten. Flödet GET /v1/webhook-events returnerar samma sak utan sequence, payload och test.

Fält

  • idstringobligatorisk

    Händelsens id (evt_…), skickas också som huvudet webhook-id. Använd det för att kasta dubblettleveranser.

  • typeWebhookEventTypeobligatorisk
  • created_atstring (date-time)obligatorisk

    När ändringen inträffade (UTC).

  • org_idintegerobligatorisk
  • api_versionstringobligatorisk

    Kontraktsversion för schemat data.

  • sequenceinteger

    Leveransens löpnummer inom webhooken (saknas för en testhändelse).

  • objectWebhookEventObjectobligatorisk
  • payloadstringobligatorisk

    thin betyder ingen data: läs objektet via API:et.

    Tillåtna värden: fullthin

  • dataobject

    Nyttolast; dess form beror på händelsetypen.

  • testbooleanobligatorisk

    En testhändelse som skickas av POST /v1/webhooks/{webhook_id}/test.

Ingår i

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing