WebhookSubscriptionCreateRequest
Creates an active subscription at revision 1 with a new secret (1.63.0). Every issue is a detail of 422 validation_failed: the selection issues of WebhookSelectionIssueCode and egress_denied at /url; a filter of no Organization is not_found.
An object with 7 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
compliance_policy_firings | boolean | no | The 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_types | array of EventTypeName | no | None when omitted. |
families | array of EventFamily | no | |
filter_id | EventFilterId or null | no | |
include | array of WebhookInclude | no | |
purpose | WebhookPurpose | no | general when omitted at creation. |
url | string | yes | The 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.