Przejdź do treści
Sursa Developers

Obiekty

WebhookDeliveryBody

Treść dostarczenia webhooka (sekcja webhooks:): koperta zdarzenia i pola dostarczenia. Kanał GET /v1/webhook-events zwraca to samo bez sequence, payload i test.

Pola

  • idstringwymagane

    ID zdarzenia (evt_…), wysyłany także jako nagłówek webhook-id. Używaj go do odrzucania zduplikowanych dostarczeń.

  • typeWebhookEventTypewymagane
  • created_atstring (date-time)wymagane

    Kiedy nastąpiła zmiana (UTC).

  • org_idintegerwymagane
  • api_versionstringwymagane

    Wersja kontraktu schematu data.

  • sequenceinteger

    Numer kolejny dostarczenia w obrębie webhooka (brak dla zdarzenia testowego).

  • objectWebhookEventObjectwymagane
  • payloadstringwymagane

    thin oznacza brak data: odczytaj obiekt przez API.

    Dozwolone wartości: fullthin

  • dataobject

    Treść zdarzenia; jej struktura zależy od typu zdarzenia.

  • testbooleanwymagane

    Zdarzenie testowe wysłane przez POST /v1/webhooks/{webhook_id}/test.

Część

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing