Zum Inhalt springen
Sursa Developers

Objekte

WebhookDeliveryBody

Body einer Webhook-Zustellung (der Abschnitt webhooks:): der Umschlag des Ereignisses und die Felder der Zustellung. Der Feed GET /v1/webhook-events gibt dasselbe ohne sequence, payload und test zurück.

Felder

  • idstringerforderlich

    Ereignis-ID (evt_…), auch als Header webhook-id gesendet. Verwenden Sie sie, um doppelte Zustellungen zu verwerfen.

  • typeWebhookEventTypeerforderlich
  • created_atstring (date-time)erforderlich

    Wann die Änderung stattgefunden hat (UTC).

  • org_idintegererforderlich
  • api_versionstringerforderlich

    Vertragsversion des Schemas von data.

  • sequenceinteger

    Laufende Nummer der Zustellung innerhalb des Endpunkts (fehlt bei einem Testereignis).

  • objectWebhookEventObjecterforderlich
  • payloadstringerforderlich

    thin bedeutet kein data: Lesen Sie das Objekt über die API.

    Zulässige Werte: fullthin

  • dataobject

    Payload; ihre Form hängt vom Ereignistyp ab.

  • testbooleanerforderlich

    Ein Testereignis, gesendet durch POST /v1/webhooks/{webhook_id}/test.

Teil von

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing