Webhook Event object representation

The webhookevent object representation and fields are described below.

webhookevent was introduced in API version V1

webhookevent has not been marked for deprecation

Description

The webhook event representation is used for webhook message delivery acting like an envelope for the event.

Fields

NameTypeDescriptionConstraints
triggerWebhook TriggerThe originating trigger event which initiated this delivery event as part of a delivery attempt.Ignored on update.
subscriptionWebhook SubscriptionThe subscription metadata which routed the trigger event for the deliveryIgnored on update.
v1The native API V1 entrypoint for accessing the representation which was updated. Note that in the case of deletions the target concept may be gonewhen the client attempts to fetch. Many deletion operations are async but some are synchronous and will complete before the webhook delivery.Ignored on update.