VocalDocscontracts 1.65.0

WebhookSubscriptionUpdateRequest

Replaces the named fields at the revision If-Match names (1.63.0), checked as a creation is on the merged subscription; the status, the secret and api_version change through their own routes or never.

An object with 7 fields.

Fields

FieldTypeRequiredDescription
compliance_policy_firingsbooleannoThe opt-in to the record form of a compliance-tagged Policy firing, policy.compliance_fired (1.63.0): true delivers each to this subscription; false by default. From 1.64.0, stated: the subscription's event filter narrows it as it narrows every other type, since a filter the customer set holds.
event_typesarray of EventTypeNameno
familiesarray of EventFamilyno
filter_idEventFilterId or nullno
includearray of WebhookIncludeno
purposeWebhookPurposenogeneral when omitted at creation.
urlstringnoThe https URL deliveries are posted to, checked by the egress guard when saved and at every delivery (egress_denied).

Used by

The operations whose parameters, request body or responses name this shape directly.