SUsuprsend

Commit Schema

Changed on

Commit a draft schema to make it live. Changes will start to take effect as soon as it's live.

patch/v1/{workspace}/schema/{schema_slug}/commit/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

schema_slugstring required

Unique identifier of the schema

Query parameters

commit_messagestring

Commit message describing the changes

Response

Schema committed. The response is the newly committed live version.

slugstring

Unique identifier for the schema

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.

status'draft' | 'live'

Status of the returned schema version.

hashstring

Git-like hash for version tracking

json_schemaobject nullable

updated json schema

created_atstring date-time

When the schema was created

updated_atstring date-time

When the schema was last updated

committed_atstring date-time

When the schema was last committed

commit_messagestring

Last commit message

Example response

{
  "slug": "new-order-placed",
  "name": "Order Placed Event",
  "description": "Schema for order placement action",
  "status": "live",
  "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",
  "committed_at": "2025-09-01T18:35:00.270698Z",
  "commit_message": "required fields updated"
}

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

    • info

      added the non-success response with the status

    • info

      added the success response with the status