Harness · Schema
trigger
DevOpsGitOpsInternal Developer PortalLifecycleSoftware DeliveryCI/CDContinuous DeliveryContinuous Integration
Properties
| Name | Type | Description |
|---|---|---|
| trigger | object |
JSON Schema
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"type" : "object",
"title" : "trigger",
"required" : [ "trigger" ],
"properties" : {
"trigger" : {
"$ref" : "#/definitions/trigger/trigger"
}
},
"definitions" : {
"trigger" : {
"trigger" : {
"type" : "object",
"title" : "trigger",
"required" : [ "identifier", "orgIdentifier", "projectIdentifier" ],
"properties" : {
"description" : {
"type" : "string"
},
"enabled" : {
"type" : "boolean"
},
"encryptedWebhookSecretIdentifier" : {
"type" : "string"
},
"identifier" : {
"type" : "string",
"pattern" : "^[a-zA-Z_][0-9a-zA-Z_]{0,127}$"
},
"inputSetRefs" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "string",
"pattern" : "(<\\+.+>.*)",
"minLength" : 1
} ]
},
"inputYaml" : {
"type" : "string"
},
"name" : {
"type" : "string",
"pattern" : "^[a-zA-Z_0-9-.][-0-9a-zA-Z_\\s.]{0,127}$"
},
"orgIdentifier" : {
"type" : "string"
},
"pipelineBranchName" : {
"type" : "string"
},
"pipelineIdentifier" : {
"type" : "string"
},
"projectIdentifier" : {
"type" : "string"
},
"source" : {
"$ref" : "#/definitions/trigger/trigger_source"
},
"stagesToExecute" : {
"oneOf" : [ {
"type" : "array",
"items" : {
"type" : "string"
}
}, {
"type" : "string",
"pattern" : "(<\\+.+>.*)",
"minLength" : 1
} ]
},
"tags" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
}
},
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"trigger_source" : {
"title" : "trigger_source",
"type" : "object",
"properties" : {
"pollInterval" : {
"type" : "string",
"pattern" : "(((([1-9])+\\d*[mh])+(\\s/?\\d+[mh])*)|(^$)|(0))$"
},
"type" : {
"type" : "string",
"enum" : [ "Webhook", "Artifact", "Manifest", "Scheduled", "MultiRegionArtifact", "SystemEvent" ]
},
"webhookId" : {
"type" : "string"
}
},
"$schema" : "http://json-schema.org/draft-07/schema#",
"allOf" : [ {
"if" : {
"properties" : {
"type" : {
"const" : "Artifact"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/trigger_type/artifact_trigger"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Manifest"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/trigger_type/manifest_trigger"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "MultiRegionArtifact"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/trigger_type/multi_region_trigger"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Scheduled"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/trigger_type/scheduled_trigger"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Webhook"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/trigger_type/webhook_trigger"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "SystemEvent"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/trigger_type/system_event_trigger"
}
}
}
} ]
},
"trigger_type" : {
"artifact_trigger" : {
"title" : "artifact_trigger",
"allOf" : [ {
"$ref" : "#/definitions/trigger/trigger_spec"
}, {
"type" : "object",
"properties" : {
"artifactRef" : {
"type" : "string"
},
"stageIdentifier" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "Gcr", "Ecr", "DockerRegistry", "Nexus3Registry", "Nexus2Registry", "ArtifactoryRegistry", "Acr", "AmazonS3", "Jenkins", "CustomArtifact", "GoogleArtifactRegistry", "GithubPackageRegistry", "AzureArtifacts", "AmazonMachineImage", "GoogleCloudStorage", "GceImage", "Bamboo" ]
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Acr"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/acr_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "AmazonMachineImage"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/ami_registry_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "AmazonS3"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/amazon_s3_registry"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "ArtifactoryRegistry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/artifactory_registry"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "AzureArtifacts"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/azure_artifact"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Bamboo"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/bamboo"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "CustomArtifact"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/custom_artifact"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "DockerRegistry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/docker_registry"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Ecr"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/ecr"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Gcr"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/gcr"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "GithubPackageRegistry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/github_packages"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "GoogleArtifactRegistry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/gar_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "GoogleCloudStorage"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/google_cloud"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "GceImage"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/gce_image_registry_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Jenkins"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/jenkins_registry"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Nexus2Registry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/nexus"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Nexus3Registry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/artifact_trigger/nexus_registry"
}
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"manifest_trigger" : {
"title" : "manifest_trigger",
"allOf" : [ {
"$ref" : "#/definitions/trigger/trigger_spec"
}, {
"type" : "object",
"properties" : {
"manifestRef" : {
"type" : "string"
},
"stageIdentifier" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "HelmChart" ]
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "HelmChart"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/manifest_trigger/helm_spec"
}
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"multi_region_trigger" : {
"title" : "multi_region_trigger",
"allOf" : [ {
"$ref" : "#/definitions/trigger/trigger_spec"
}, {
"type" : "object",
"properties" : {
"artifactRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"sources" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/multi_region_artifact/artifact_type_spec_wrapper"
}
},
"stageIdentifier" : {
"type" : "string"
},
"type" : {
"type" : "string",
"enum" : [ "Gcr", "Ecr", "DockerRegistry", "Nexus3Registry", "Nexus2Registry", "ArtifactoryRegistry", "Acr", "AmazonS3", "Jenkins", "CustomArtifact", "GoogleArtifactRegistry", "GithubPackageRegistry", "AzureArtifacts", "AmazonMachineImage", "GoogleCloudStorage", "Bamboo" ]
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"scheduled_trigger" : {
"title" : "scheduled_trigger",
"allOf" : [ {
"$ref" : "#/definitions/trigger/trigger_spec"
}, {
"type" : "object",
"properties" : {
"type" : {
"type" : "string"
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Cron"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/scheduled_trigger/cron_trigger_spec"
}
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"webhook_trigger" : {
"title" : "webhook_trigger",
"allOf" : [ {
"$ref" : "#/definitions/trigger/trigger_spec"
}, {
"type" : "object",
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "AzureRepo", "Github", "Gitlab", "Bitbucket", "Custom", "AwsCodeCommit", "Harness", "EventRelay", "HarnessArtifactRegistry" ]
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "AwsCodeCommit"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/aws_commit_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "AzureRepo"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/azure_repo_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Bitbucket"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/bitbucket_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Custom"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/custom_trigger_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Github"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/github_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Gitlab"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/gitlab_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Harness"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/harness_spec"
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "EventRelay"
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/event_bridge_spec"
}
}
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "HarnessArtifactRegistry"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/webhook_trigger/harness_artifact_registry_spec"
}
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"system_event_trigger" : {
"title" : "system_event_trigger",
"allOf" : [ {
"$ref" : "#/definitions/trigger/trigger_spec"
}, {
"type" : "object",
"required" : [ "type", "spec" ],
"properties" : {
"type" : {
"type" : "string",
"enum" : [ "Pipeline" ]
}
}
}, {
"if" : {
"properties" : {
"type" : {
"const" : "Pipeline"
}
}
},
"then" : {
"properties" : {
"spec" : {
"$ref" : "#/definitions/trigger/system_event_trigger/pipeline_system_event_spec"
}
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
}
},
"trigger_spec" : {
"title" : "trigger_spec",
"type" : "object",
"discriminator" : "type",
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"artifact_trigger" : {
"acr_spec" : {
"title" : "acr_spec",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"registry" : {
"type" : "string"
},
"repository" : {
"type" : "string"
},
"subscriptionId" : {
"type" : "string"
},
"tag" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"artifact_type_spec" : {
"title" : "artifact_type_spec",
"type" : "object",
"discriminator" : "type",
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"ami_registry_spec" : {
"title" : "ami_registry_spec",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"filters" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/artifact_trigger/ami_filter"
}
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"region" : {
"type" : "string"
},
"tags" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/artifact_trigger/ami_tag"
}
},
"version" : {
"type" : "string"
},
"versionRegex" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"ami_filter" : {
"title" : "ami_filter",
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
},
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"ami_tag" : {
"title" : "ami_tag",
"type" : "object",
"properties" : {
"name" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
},
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"amazon_s3_registry" : {
"title" : "amazon_s3_registry",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"bucketName" : {
"type" : "string"
},
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"filePathRegex" : {
"type" : "string"
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"region" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"artifactory_registry" : {
"title" : "artifactory_registry",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"artifactDirectory" : {
"type" : "string"
},
"artifactFilter" : {
"type" : "string"
},
"artifactPath" : {
"type" : "string"
},
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"repository" : {
"type" : "string"
},
"repositoryFormat" : {
"type" : "string"
},
"repositoryUrl" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"azure_artifact" : {
"title" : "azure_artifact",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"feed" : {
"type" : "string"
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"packageName" : {
"type" : "string"
},
"packageType" : {
"type" : "string"
},
"project" : {
"type" : "string"
},
"version" : {
"type" : "string"
},
"versionRegex" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"bamboo" : {
"title" : "bamboo",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"artifactPaths" : {
"type" : "array",
"items" : {
"type" : "string"
}
},
"build" : {
"type" : "string"
},
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"planKey" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"custom_artifact" : {
"title" : "custom_artifact",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"artifactsArrayPath" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"inputs" : {
"type" : "array",
"items" : {
"oneOf" : [ {
"$ref" : "#/definitions/pipeline/numberVariable"
}, {
"$ref" : "#/definitions/pipeline/secretVariable"
}, {
"$ref" : "#/definitions/pipeline/stringVariable"
} ]
}
},
"jexlCondition" : {
"type" : "string"
},
"metaDataConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"metadata" : {
"type" : "object",
"additionalProperties" : {
"type" : "string"
}
},
"script" : {
"type" : "string"
},
"version" : {
"type" : "string"
},
"versionPath" : {
"type" : "string"
}
}
} ],
"$schema" : "http://json-schema.org/draft-07/schema#"
},
"docker_registry" : {
"title" : "docker_registry",
"allOf" : [ {
"$ref" : "#/definitions/trigger/artifact_trigger/artifact_type_spec"
}, {
"type" : "object",
"properties" : {
"connectorRef" : {
"type" : "string"
},
"eventConditions" : {
"type" : "array",
"items" : {
"$ref" : "#/definitions/trigger/trigger_event_data"
}
},
"imagePath" : {
# --- truncated at 32 KB (108 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/harness/refs/heads/main/json-schema/harness-v0-trigger-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/harness-v0-trigger"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.