Component schema

AgenticWorkflowAnnotations

object1 direct reference

Definition

stringread only

The time at which this automation was originally created.

stringread only

The member ID of the user who originally created this automation.

stringread only

The time at which the current version of this automation was created.

stringread only

The member ID of the user who created the current version of this automation.

string

Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.

string

Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.

stringread only

The plaintext webhook secret, returned exactly once: immediately after the backend auto-provisions it on create or update (the first time a webhook trigger is added). Absent on every other response, including subsequent reads of the same workflow — it is stored only as an encrypted value and cannot be retrieved again. Use POST .../webhook (regenerate) to obtain a new one if this value was missed.

string

Webhook-trigger-scoped feature flag, independent of the workflow's own spec.enabled. Client-settable on write (via PUT/upsert), defaults to "true". "true" if the webhook trigger is active, "false" if it is paused. Pausing keeps the secret and webhook id intact; incoming requests are silently accepted but not forwarded.

Used by 1

These schemas and endpoints reference this type directly.

SchemaAgenticWorkflowMetadata

json

OpenAPI source1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
{
  "properties": {
    "dash0.com/created-at": {
      "description": "The time at which this automation was originally created.",
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "dash0.com/created-by": {
      "description": "The member ID of the user who originally created this automation.",
      "type": "string",
      "readOnly": true
    },
    "dash0.com/last-updated-at": {
      "description": "The time at which the current version of this automation was created.",
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "dash0.com/last-updated-by": {
      "description": "The member ID of the user who created the current version of this automation.",
      "type": "string",
      "readOnly": true
    },
    "dash0.com/deleted-at": {
      "type": "string",
      "format": "date-time"
    },
    "dash0.com/folder-path": {
      "description": "Optional UI folder path for organising groups (e.g. '/infrastructure/hosts'). Nesting is expressed with '/' separators.",
      "type": "string"
    },
    "dash0.com/sharing": {
      "description": "Comma-separated list of principals to grant read access to. Supported formats: 'team:<team_id>' and 'user:<email>'. Example: 'team:team_01abc,user:alice@example.com'. Sharing is honored only on assets that declare a dash0.com/origin (for example those managed by Terraform, the operator, the CLI, or the API). Setting it on an asset that declares no dash0.com/origin is rejected with a 400 — manage that asset's access via the UI share dialog instead.",
      "type": "string"
    },
    "dash0.com/webhook-secret": {
      "description": "The plaintext webhook secret, returned exactly once: immediately after the backend\nauto-provisions it on create or update (the first time a webhook trigger is added).\nAbsent on every other response, including subsequent reads of the same workflow — it\nis stored only as an encrypted value and cannot be retrieved again. Use\n`POST .../webhook` (regenerate) to obtain a new one if this value was missed.\n",
      "type": "string",
      "readOnly": true
    },
    "dash0.com/webhook-trigger-enabled": {
      "description": "Webhook-trigger-scoped feature flag, independent of the workflow's own `spec.enabled`.\nClient-settable on write (via PUT/upsert), defaults to `\"true\"`. `\"true\"` if the\nwebhook trigger is active, `\"false\"` if it is paused. Pausing keeps the secret and\nwebhook id intact; incoming requests are silently accepted but not forwarded.\n",
      "type": "string"
    }
  }
}