WebhookSubscriptionCreated
The answer of a creation (1.63.0): the subscription with its secret, which no later read shows.
An object with 20 fields.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
api_version | "v1" | yes | The envelope version, fixed at creation. |
compliance_policy_firings | boolean | yes | 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. |
created_at | Timestamp | yes | |
disabled_at | Timestamp or null | yes | |
disabled_reason | WebhookDisabledReason or null | yes | Why the platform disabled it; null unless disabled. |
event_types | array of EventTypeName | yes | The record types the subscription receives, beside its families. |
families | array of EventFamily | yes | Whole families the subscription receives, beside event_types; at least one of the two is non-empty (1.52.0). |
filter_id | EventFilterId or null | yes | The event filter that narrows the selection, or null (1.52.0). |
id | WebhookId | yes | |
include | array of WebhookInclude | yes | Opt-in additions to a post_call delivery; empty for a general one (1.52.0). |
last_delivery | WebhookLastDelivery or null | no | The newest delivery of the subscription, of any kind (1.64.0), so a list shows it without a read per subscription; null when the 30-day log holds none. Absent from an api older than 1.64.0. |
object | "webhook_subscription" | yes | |
previous_secret_expires_at | Timestamp or null | yes | When the secret before the last rotation stops signing; null outside the window. |
purpose | WebhookPurpose | yes | |
revision | integer | yes | Counts configuration writes; returned as the ETag and required in If-Match. |
secret | WebhookSecret | yes | The secret, shown in this answer only. |
secret_hint | string | yes | The last four characters of the secret. |
status | WebhookSubscriptionStatus | yes | |
updated_at | Timestamp | yes | |
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.