Chuyển tới nội dung
Sursa Developers

Đối tượng

WebhookDeliveryBody

Phần thân của lần gửi webhook (phần webhooks:): lớp bọc của sự kiện và các trường của lần gửi. Nguồn cấp GET /v1/webhook-events trả về cùng nội dung nhưng không có sequence, payload và test.

Trường

  • idstringbắt buộc

    ID sự kiện (evt_…), cũng được gửi trong header webhook-id. Dùng nó để loại bỏ các lần gửi trùng lặp.

  • typeWebhookEventTypebắt buộc
  • created_atstring (date-time)bắt buộc

    Thời điểm xảy ra thay đổi (UTC).

  • org_idintegerbắt buộc
  • api_versionstringbắt buộc

    Phiên bản hợp đồng của lược đồ data.

  • sequenceinteger

    Số thứ tự lần gửi trong phạm vi webhook (không có với sự kiện thử).

  • objectWebhookEventObjectbắt buộc
  • payloadstringbắt buộc

    thin nghĩa là không có data: hãy đọc đối tượng qua API.

    Giá trị cho phép: fullthin

  • dataobject

    Payload; cấu trúc của nó phụ thuộc vào loại sự kiện.

  • testbooleanbắt buộc

    Sự kiện thử được gửi bằng POST /v1/webhooks/{webhook_id}/test.

Thuộc

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing