BetterCloud · JSON Structure

Bettercloud Workflow Create Request Structure

Request body for creating a workflow.

Type: object Properties: 4 Required: 1
AutomationComplianceEnterpriseIT OperationsSaaS ManagementSecurityWorkflowsUser Lifecycle

WorkflowCreateRequest is a JSON Structure definition published by BetterCloud, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name description trigger_type status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bettercloud/refs/heads/main/json-structure/bettercloud-workflow-create-request-structure.json",
  "name": "WorkflowCreateRequest",
  "description": "Request body for creating a workflow.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the workflow.",
      "example": "New Employee Onboarding"
    },
    "description": {
      "type": "string",
      "description": "Description of the workflow.",
      "example": "Automated onboarding workflow for new hires"
    },
    "trigger_type": {
      "type": "string",
      "description": "Trigger type for the workflow.",
      "enum": [
        "manual",
        "event",
        "scheduled"
      ],
      "example": "event"
    },
    "status": {
      "type": "string",
      "description": "Initial status.",
      "enum": [
        "active",
        "draft"
      ],
      "example": "draft"
    }
  },
  "required": [
    "name"
  ]
}