Skip to content
Sursa Developers

Objects

WebhookDeliveryBody

Webhook delivery body (the webhooks: section): the event envelope and delivery fields. The GET /v1/webhook-events feed returns the same without sequence, payload and test.

Fields

  • idstringrequired

    Event ID (evt_…), also sent as the webhook-id header. Use it to drop duplicate deliveries.

  • typeWebhookEventTyperequired
  • created_atstring (date-time)required

    When the change happened (UTC).

  • org_idintegerrequired
  • api_versionstringrequired

    Contract version of the data schema.

  • sequenceinteger

    Delivery sequence number within the endpoint (absent for a test event).

  • objectWebhookEventObjectrequired
  • payloadstringrequired

    thin means no data: read the object through the API.

    Allowed values: fullthin

  • dataobject

    Payload; its shape depends on the event type.

  • testbooleanrequired

    A test event sent by POST /v1/webhooks/{webhook_id}/test.

Part of

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing