Direct naar de inhoud
Sursa Developers

Objecten

WebhookDeliveryBody

Body van een webhooklevering (de sectie webhooks:): de envelop van het event en de velden van de levering. De feed GET /v1/webhook-events geeft hetzelfde terug zonder sequence, payload en test.

Velden

  • idstringverplicht

    ID van het event (evt_…), ook meegestuurd als header webhook-id. Gebruik die om dubbele leveringen te negeren.

  • typeWebhookEventTypeverplicht
  • created_atstring (date-time)verplicht

    Wanneer de wijziging plaatsvond (UTC).

  • org_idintegerverplicht
  • api_versionstringverplicht

    Contractversie van het schema van data.

  • sequenceinteger

    Volgnummer van de levering binnen de webhook (ontbreekt bij een testevent).

  • objectWebhookEventObjectverplicht
  • payloadstringverplicht

    thin betekent geen data: lees het object via de API.

    Toegestane waarden: fullthin

  • dataobject

    Payload; de vorm ervan hangt af van het eventtype.

  • testbooleanverplicht

    Een testevent, verstuurd door POST /v1/webhooks/{webhook_id}/test.

Onderdeel van

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing