İçeriğe geç
Sursa Developers

Nesneler

WebhookDeliveryBody

Webhook teslim gövdesi (webhooks: bölümü): olay zarfı ve teslim alanları. GET /v1/webhook-events beslemesi aynısını sequence, payload ve test olmadan döndürür.

Alanlar

  • idstringzorunlu

    Olay kimliği (evt_…); webhook-id başlığı olarak da gönderilir. Yinelenen teslimleri ayıklamak için kullanın.

  • typeWebhookEventTypezorunlu
  • created_atstring (date-time)zorunlu

    Değişikliğin gerçekleştiği zaman (UTC).

  • org_idintegerzorunlu
  • api_versionstringzorunlu

    data şemasının sözleşme sürümü.

  • sequenceinteger

    Webhook içindeki teslim sıra numarası (test olayında yoktur).

  • objectWebhookEventObjectzorunlu
  • payloadstringzorunlu

    thin, data olmadığı anlamına gelir: nesneyi API üzerinden okuyun.

    Geçerli değerler: fullthin

  • dataobject

    Veri yükü; biçimi olay türüne bağlıdır.

  • testbooleanzorunlu

    POST /v1/webhooks/{webhook_id}/test ile gönderilen test olayı.

İçinde yer aldığı nesneler

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing