BrainGrid Controller
Workflow Builder
Events
JSON Contract Event

JSON Contract Validation Event

The JSON Contract Validation Event allows users to validate JSON data against a predefined schema or contract. This event acts as a quality gate in your workflow, ensuring that data meets the required structure and constraints before proceeding to subsequent steps.

Overview

This event enables users to:

  • Define input JSON data from static sources or previous workflow steps.
  • Specify a JSON schema/contract for validation.
  • Control workflow execution based on validation results.

Configuring a JSON Contract Validation Event

1️⃣ Basic Configuration

  1. Title & Description – Provide a meaningful name and description for the event.
  2. Event Type – Select "JSON Contract Validation" from the event type dropdown.

📌 Outcome: Establishes the event's identity and purpose within the workflow.

2️⃣ Define Input JSON Data

  1. Select Input Source:

  2. Static JSON – Enter or paste JSON directly into the input field.

  3. Carry from Previous Step – Use JSON output from a previous workflow node.

📌 Outcome: Provides the JSON data that will be validated against the contract.

3️⃣ Define JSON Contract

  1. Enter JSON Schema/Contract – Specify the schema that defines the expected structure and constraints.
  2. Test Validation (Optional) – Use the test functionality to verify if your input JSON passes validation.

📌 Outcome: Defines the validation rules that the input JSON must satisfy.

4️⃣ Configure Validation Behavior

  1. Error Handling – Specify how validation errors should be reported.
  2. Save Configuration – Finalize the event setup.

📌 Outcome: The system validates the input JSON against the contract when the event is triggered, proceeding only if validation passes.

Example

Input JSON:

{
  "user": {
    "id": "12345",
    "name": "John Doe",
    "email": "john@example.com",
    "age": 30
  }
}

JSON Contract/Schema:

{
  "type": "object",
  "required": ["user"],
  "properties": {
    "user": {
      "type": "object",
      "required": ["id", "name", "email"],
      "properties": {
        "id": {"type": "string"},
        "name": {"type": "string"},
        "email": {"type": "string", "format": "email"},
        "age": {"type": "integer", "minimum": 18}
      }
    }
  }
}

Validation Result:

  • ✅ Success: The input JSON matches the contract requirements
  • If the email was invalid or age was below 18, validation would fail and the workflow would stop

Summary

The JSON Contract Validation Event ensures data integrity within your workflows by validating JSON against predefined contracts. This prevents invalid or malformed data from propagating through your system, improving reliability and reducing errors in downstream processes. The workflow will only continue if the data passes validation, acting as a critical quality control checkpoint.

JMES Path Data Extraction EventWorkflow Logger Event