events.json

{
  "$id": "https://serverlessworkflow.io/schemas/0.8/events.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Serverless Workflow specification - events schema",
  "type": "object",
  "events": {
    "oneOf": [
      {
        "type": "string",
        "format": "uri",
        "description": "URI to a resource containing event definitions (json or yaml)"
      },
      {
        "type": "array",
        "description": "Workflow CloudEvent definitions. Defines CloudEvents that can be consumed or produced",
        "items": {
          "type": "object",
          "$ref": "#/definitions/eventdef"
        },
        "additionalItems": false,
        "minItems": 1
      }
    ]
  },
  "required": [
    "events"
  ],
  "definitions": {
    "eventdef": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Unique event name",
          "minLength": 1
        },
        "source": {
          "type": "string",
          "description": "CloudEvent source"
        },
        "type": {
          "type": "string",
          "description": "CloudEvent type"
        },
        "kind": {
          "type": "string",
          "enum": [
            "consumed",
            "produced"
          ],
          "description": "Defines the CloudEvent as either 'consumed' or 'produced' by the workflow. Default is 'consumed'",
          "default": "consumed"
        },
        "correlation": {
          "type": "array",
          "description": "CloudEvent correlation definitions",
          "minItems": 1,
          "items": {
            "type": "object",
            "$ref": "#/definitions/correlationDef"
          },
          "additionalItems": false
        },
        "dataOnly": {
          "type": "boolean",
          "default": true,
          "description": "If `true`, only the Event payload is accessible to consuming Workflow states. If `false`, both event payload and context attributes should be accessible "
        },
        "metadata": {
          "$ref": "common.json#/definitions/metadata",
          "description": "Metadata information"
        }
      },
      "additionalProperties": false,
      "if": {
        "properties": {
          "kind": {
            "const": "consumed"
          }
        }
      },
      "then": {
        "required": [
          "name",
          "source",
          "type"
        ]
      },
      "else": {
        "required": [
          "name",
          "type"
        ]
      }
    },
    "correlationDef": {
      "type": "object",
      "description": "CloudEvent correlation definition",
      "properties": {
        "contextAttributeName": {
          "type": "string",
          "description": "CloudEvent Extension Context Attribute name",
          "minLength": 1
        },
        "contextAttributeValue": {
          "type": "string",
          "description": "CloudEvent Extension Context Attribute value",
          "minLength": 1
        }
      },
      "additionalProperties": false,
      "required": [
        "contextAttributeName"
      ]
    }
  }
}