Перейти к содержанию
Sursa для разработчиков

Объекты

WebhookDeliveryBody

Тело доставки вебхука (раздел webhooks:): конверт события и поля доставки. Лента GET /v1/webhook-events возвращает то же без sequence, payload и test.

Поля

  • idstringобязательно

    ID события (evt_…), передаётся также в заголовке webhook-id. По нему отбрасывайте повторные доставки.

  • typeWebhookEventTypeобязательно
  • created_atstring (date-time)обязательно

    Когда произошло изменение (UTC).

  • org_idintegerобязательно
  • api_versionstringобязательно

    Версия контракта схемы data.

  • sequenceinteger

    Порядковый номер доставки в пределах вебхука (нет у проверочного события).

  • objectWebhookEventObjectобязательно
  • payloadstringобязательно

    thin — без data: читайте объект через API.

    Допустимые значения: fullthin

  • dataobject

    Данные события; их форма зависит от типа события.

  • testbooleanобязательно

    Проверочное событие, отправленное POST /v1/webhooks/{webhook_id}/test.

Входит в

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing