WebhookConfig file
| File name | Resource |
|---|---|
*.webhook.yaml | WebhookConfig |
GitOps file for a single space.
Identity
originKey: GitOps identity of the resource this file owns. The same value as the API's originKey.id: Server-assigned id. Absent until the resource exists.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
body | string | Optional | Optional body template with Liquid syntax support. May be null. At most 1000000 characters. |
eventName | enum | Required | The event that triggers this webhook. One of CaseCreated, CaseClosed, CaseStatusChanged, CaseInitialAnalysisCompleted, ContentWorkItemCreated, ThreatReportCreated, CircuitBreakerTripped, SimbaUsageAlert, TriagePromotionThresholdChanged, AlertQueued, AlertInitialScoreCompleted, AlertPromoted, AlertExpired, AlertTriageFailure, CaseNewAlertEvidenceAttached. |
folder | string | Optional | A Folder by its originKey (managed in this repo) or its server id (FLD_…). |
headers | map of string | Optional | Header name to value. Values support Liquid. Keep secrets in credentials and reference them, for example "Bearer {{ credential.my_token }}". Literal values on sensitive headers such as Authorization, Cookie, or names whose last word marks a secret (for example token, key or session) are rejected, and existing ones read back as "[redacted]". When you update an existing resource without changing its URL, sending "[redacted]" back keeps the stored value. Create requests and URL changes reject "[redacted]". |
id | string | Optional | Server-assigned id. Absent until the resource exists. Pattern: ^WHK_[A-Z0-9]{1,7}$. |
method | enum | Required | One of GET, POST, PUT, PATCH, DELETE. |
name | string | Required | |
originKey | string | Required | GitOps identity of the resource this file owns. The same value as the API's originKey. Pattern: ^(?!perpetual:)[a-z][a-z0-9-]{0,31}:[A-Za-z0-9._~\-/:@]{1,256}$. |
spaceId | string | Required | Space the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$. |
triggerExpression | string | Optional | Optional Liquid template gating dispatch; fires only when the rendered, trimmed output is "true". May be null. At most 1000000 characters. |
url | string | Required |
In a content pack
A content pack's source directory uses the same file, with these differences:
- Not used in a pack:
originKey,spaceId. - These fields are new in a pack, or have a different type, requirement or meaning there:
| Field | Type | Required | Description |
|---|---|---|---|
folder | string | Optional | id of a Folder file in the same pack. Omit to place the item at the pack root. Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$. |
id | string | Required | Format: uuid. Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$. |
Related
Perpetual CLI 0.5.0