Skip to main content

WebhookConfig file

File nameResource
*.webhook.yamlWebhookConfig

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​

FieldTypeRequiredDescription
bodystringOptionalOptional body template with Liquid syntax support. May be null. At most 1000000 characters.
eventNameenumRequiredThe event that triggers this webhook. One of CaseCreated, CaseClosed, CaseStatusChanged, CaseInitialAnalysisCompleted, ContentWorkItemCreated, ThreatReportCreated, CircuitBreakerTripped, SimbaUsageAlert, TriagePromotionThresholdChanged, AlertQueued, AlertInitialScoreCompleted, AlertPromoted, AlertExpired, AlertTriageFailure, CaseNewAlertEvidenceAttached.
folderstringOptionalA Folder by its originKey (managed in this repo) or its server id (FLD_…).
headersmap of stringOptionalHeader 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]".
idstringOptionalServer-assigned id. Absent until the resource exists. Pattern: ^WHK_[A-Z0-9]{1,7}$.
methodenumRequiredOne of GET, POST, PUT, PATCH, DELETE.
namestringRequired
originKeystringRequiredGitOps 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}$.
spaceIdstringRequiredSpace the resource belongs to. Pattern: ^SPC_[A-Z0-9]{1,7}$.
triggerExpressionstringOptionalOptional Liquid template gating dispatch; fires only when the rendered, trimmed output is "true". May be null. At most 1000000 characters.
urlstringRequired

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:
FieldTypeRequiredDescription
folderstringOptionalid 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)$.
idstringRequiredFormat: 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)$.

Perpetual CLI 0.5.0