Siirry sisältöön
Sursa Developers

Objektit

WebhookDeliveryBody

Webhook-toimituksen runko (webhooks:-osio): tapahtuman kääre ja toimituksen kentät. GET /v1/webhook-events-syöte palauttaa saman ilman kenttiä sequence, payload ja test.

Kentät

  • idstringpakollinen

    Tapahtuman tunnus (evt_…), joka lähetetään myös webhook-id-otsakkeena. Käytä sitä kaksoistoimitusten pudottamiseen.

  • typeWebhookEventTypepakollinen
  • created_atstring (date-time)pakollinen

    Milloin muutos tapahtui (UTC).

  • org_idintegerpakollinen
  • api_versionstringpakollinen

    data-skeeman sopimusversio.

  • sequenceinteger

    Toimituksen järjestysnumero webhookin sisällä (puuttuu testitapahtumalta).

  • objectWebhookEventObjectpakollinen
  • payloadstringpakollinen

    thin tarkoittaa, ettei data-kenttää ole: lue objekti API:n kautta.

    Sallitut arvot: fullthin

  • dataobject

    Hyötykuorma; sen rakenne riippuu tapahtumatyypistä.

  • testbooleanpakollinen

    POST /v1/webhooks/{webhook_id}/test-toiminnon lähettämä testitapahtuma.

Sisältyy

EventAccessRequestCreatedEventAccessRequestResolvedEventAnnouncementReadEventAnnouncementSentEventApiKeyCreatedEventApiKeyExpiringEventApiKeyRevokedEventAppAuthorizedEventAppRevokedEventCardArchivedEventCardCreatedEventCardDeletedEventCardIndexFailedEventCardIndexedEventCardMovedEventCardPublishedEventCardRestoredEventCardUnverifiedEventCardUpdatedEventCardVerifiedEventCollectionCreatedEventCollectionDeletedEventCollectionUpdatedEventCommentCreatedEventCommentResolvedEventCreditsLowEventDraftApprovedEventDraftCreatedEventDraftPublishRequestedEventExportReadyEventFolderCreatedEventFolderDeletedEventFolderUpdatedEventGapDetectedEventGroupCreatedEventGroupDeletedEventGroupMemberAddedEventGroupMemberRemovedEventGroupUpdatedEventImportDocumentFailedEventImportSyncCompletedEventInvoiceIssuedEventInvoicePaidEventJobCompletedEventJobFailedEventQuestionAnsweredEventQuestionFeedbackCreatedEventQuestionUnansweredEventSourceConnectionLostEventSourceSyncCompletedEventSourceSyncFailedEventSubscriptionUpdatedEventUserCreatedEventUserDeactivatedEventUserOffboardedEventUserUpdatedEventVerificationExpiredEventVerificationRequestedEventWebhookEndpointDisabledEventWebhookPing