Workflow JSON Schema Reference
The following json can be used with our API to import fully functional workflows in Manifestly.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Manifestly Checklist Export",
"type": "object",
"additionalProperties": false,
"properties": {
"checklist": {
"$ref": "#/$defs/checklist"
},
"checklist_run_links": {
"type": "array",
"items": {
"$ref": "#/$defs/run_link"
}
},
"main_steps": {
"type": "array",
"items": {
"anyOf": [
{
"$ref": "#/$defs/step"
}
]
}
},
"conditionals": {
"type": "array",
"items": {
"$ref": "#/$defs/conditional"
}
}
},
"$defs": {
"checklist": {
"type": "object",
"additionalProperties": false,
"properties": {
"reminders": {
"type": "array",
"items": {
"$ref": "#/$defs/reminder"
}
},
"hooks": {
"type": "array",
"items": {
"$ref": "#/$defs/hook"
}
},
"tag_list": {
"type": "array",
"items": {
"type": "string"
}
},
"title": {
"type": "string"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"expected_duration": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"hide_steps_from_external": {
"type": "boolean",
"default": false
},
"channel": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"expected_duration_units": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"business_days": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday",
"Sunday"
]
}
},
"lede": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"external_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"only_assigned_can_complete": {
"type": "boolean",
"default": false
},
"deactivated_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"hide_numbers": {
"type": "boolean",
"default": true
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"industry_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"last_run_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
}
}
},
"step": {
"type": "object",
"additionalProperties": false,
"if": {
"properties": {
"header_step": {
"const": false
}
}
},
"then": {
"not": {
"required": [
"substeps"
]
}
},
"properties": {
"content_objects": {
"type": "array",
"items": {
"$ref": "#/$defs/content_object"
}
},
"subtasks": {
"type": "array",
"items": {
"$ref": "#/$defs/subtask"
}
},
"step_triggers": {
"type": "array",
"items": {
"$ref": "#/$defs/step_trigger"
}
},
"assignment": {
"$ref": "#/$defs/assignment"
},
"data_setting": {
"$ref": "#/$defs/data_setting"
},
"substeps": {
"type": "array",
"items": {
"$ref": "#/$defs/step"
}
},
"hooks": {
"type": "array",
"items": {
"$ref": "#/$defs/hook"
}
},
"reminders": {
"type": "array",
"items": {
"$ref": "#/$defs/reminder"
}
},
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"header_step": {
"type": "boolean",
"default": false
},
"late_at_offset": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"late_at_offset_units": {
"anyOf": [
{
"type": "string",
"enum": [
"minutes",
"hours",
"days"
]
},
{
"type": "null"
}
]
},
"late_at_basis": {
"anyOf": [
{
"type": "string",
"enum": [
"beginning_of_run",
"previous_step",
"run_due_date",
"date_data_setting"
]
},
{
"type": "null"
}
]
},
"late_at_basis_step_data_setting_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"subtasks_required": {
"type": "boolean",
"default": false
},
"conditional_operator": {
"type": "string",
"enum": [
"and",
"or"
],
"default": "and"
}
}
},
"assignment": {
"type": "object",
"additionalProperties": false,
"properties": {
"assigned_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"assignee_id": {
"type": "integer"
},
"assignee_type": {
"type": "string",
"enum": [
"Membership",
"Role"
]
}
}
},
"data_setting": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"required": {
"type": "boolean"
},
"label": {
"anyOf": [
{
"type": "string",
"maxLength": 30
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"value_format": {
"type": "string",
"enum": [
"text",
"list",
"number",
"date",
"datetime",
"image",
"file",
"signature",
"url",
"email",
"paragraph",
"phone"
]
},
"value_format_config": {
"type": "object",
"additionalProperties": false,
"properties": {
"values": {
"type": "array",
"items": {
"type": "string"
}
},
"value_selection_type": {
"type": "string",
"enum": [
"single",
"multi"
]
}
}
}
}
},
"reminder": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"reminder_at_offset": {
"type": "integer"
},
"reminder_at_offset_units": {
"type": "string",
"enum": [
"minutes",
"hours",
"days"
]
},
"reminder_at_basis": {
"type": "string",
"enum": [
"beginning_of_run",
"run_due_date",
"step_due_date"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"hook": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"url": {
"type": "string"
},
"event": {
"type": "string",
"enum": [
"completed",
"late",
"started",
"step_completed",
"step_late",
"step_skipped",
"tag_changed"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"version": {
"type": "integer",
"minimum": 1,
"maximum": 2
},
"custom_body": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"use_custom_body": {
"type": "boolean",
"default": false
},
"metadata": {
"type": "object"
}
}
},
"run_link": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"tag_list": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"user_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
},
"data_choices": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"roles_to_users": {
"anyOf": [
{
"type": "object"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
},
"step_trigger": {
"type": "object",
"additionalProperties": false,
"properties": {
"to": {
"type": "string"
},
"reply_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"body": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"event": {
"type": "string",
"enum": [
"email",
"sms"
]
}
}
},
"conditional": {
"type": "object",
"additionalProperties": false,
"properties": {
"satisfier_id": {
"type": "integer"
},
"satisfying_value": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"dependent_id": {
"type": "integer"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"operator": {
"type": "string",
"enum": [
"equals",
"does_not_equal",
"includes",
"less_than",
"less_than_or_equal_to",
"greater_than",
"greater_than_or_equal_to",
"is_not_blank",
"is_blank"
]
}
}
},
"content_object": {
"type": "object",
"additionalProperties": false,
"properties": {
"content": {
"type": "string"
},
"upload_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
]
},
"caption": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
},
"content_type": {
"type": "string",
"enum": [
"file",
"image",
"text",
"video"
]
}
}
},
"subtask": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
},
"title": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"updated_at": {
"type": "string",
"format": "date-time"
}
}
}
}
}
View the current JSON Schema for complete format requirements.
Example:
{
"checklist": {
"title": "Example Workflow",
"description": "This is an example workflow to help understand the json strcuture."
},
"main_steps": [
{
"title": "Section Header One",
"header_step": true,
"substeps": [
{
"title": "First step in the first section"
},
{
"title": "Second step in the first section"
}
]
},
{
"title": "Section Header Two",
"header_step": true,
"substeps": [
{
"title": "First step in the second section"
},
{
"title": "Second step in the second section"
}
]
}
]
}