AckdbEventTypeFieldInput

One field within an event type's content schema. `requiredWhen` makes an otherwise-optional field conditionally required based on the value of a sibling field.

Properties

typestringrequired

Field value type.

"string""number""boolean""datetime""string_array"

requiredbooleanrequired

Whether the field must always be present.

descriptionstringrequired

What the field means (for AI agents and workflow builders).

example

An example value for this field.

computeHintstring

How to extract this field from the raw source API.

allowedValuesarray of

Optional enum constraint.

string

requiredWhenobject

Conditional requirement: required only when a sibling field has one of the listed values.

fieldstringrequired

Sibling field name to inspect.

valueInarray ofrequired

string

Example

AckdbEventTypeFieldInput example

{
  "type": "string",
  "required": false,
  "description": "string",
  "example": null,
  "computeHint": "string",
  "allowedValues": [
    "string"
  ],
  "requiredWhen": {
    "field": "string",
    "valueIn": [
      "string"
    ]
  }
}