SUsuprsend

Create/Update Schema

Changed on

Upset draft version of a JSON schema. Creates a new schema if it doesn't exist.

post/v1/{workspace}/schema/{schema_slug}/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

schema_slugstring required

Unique identifier of the schema

Query parameters

commitboolean

Set to true to commit the schema immediately after creation/update

commit_messagestring

Optional commit message describing the changes. Used only when commit=true.

Request body

namestring

Human-readable name of the schema

descriptionstring nullable

Description of the schema. Can be used to describe which action this schema is linked to.

is_enabledboolean

Whether the schema is enabled.

json_schemaobject

Structure of the workflow or event payload. Follows standard json schema specification. You can link this schema to a workflow or event to validate their input payload in API response. Same schema can be linked to multiple workflows and events.

Example request

{
  "name": "Order Placed Event",
  "description": "Schema for order placement action",
  "json_schema": {
    "type": "object",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": [
      "order_id",
      "amount"
    ],
    "properties": {
      "order_id": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      }
    },
    "additionalProperties": true
  }
}

Response

Schema created (returns 202 Accepted when an existing schema's draft is updated). The response is the saved draft version. When commit=true and the commit succeeds, the response is the newly committed live version instead.

slugstring

Unique identifier for the schema

namestring

Human-readable name of the schema

descriptionstring nullable

Description of the schema

status'draft' | 'live'

Status of the returned schema version. draft, or live when commit=true and the commit succeeds.

hashstring

Git-like hash for version tracking

json_schemaobject nullable

JSON schema passed in the request body.

created_atstring date-time

When the schema was created

updated_atstring date-time

When the schema was last updated

Example response

{
  "slug": "new-order-placed",
  "name": "Order Placed Event",
  "description": "Schema for order placement action",
  "status": "draft",
  "hash": "382b707d4b1f8999a1xxxxxxxx",
  "json_schema": {
    "type": "object",
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "required": [
      "order_id",
      "amount"
    ],
    "properties": {
      "order_id": {
        "type": "string"
      },
      "amount": {
        "type": "string"
      }
    },
    "additionalProperties": true
  },
  "created_at": "2025-08-27T09:30:57.945326Z",
  "updated_at": "2025-08-29T15:37:37.650177Z",
  "commit_result": {
    "is_committed": false,
    "errors": [
      "hash: no uncommitted changes found"
    ]
  }
}

Changes

  • 5f0169085547Revision changes
    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      removed the success response with the status

    • warning

      the request property's maxLength was set to 128

    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      added the success response with the status

    • info

      added the success response with the status