Codefresh Triggers API
Only for registry, helm and cron triggers
Work with this as data
Every API 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 apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.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 API
curl "https://apis.io/api/v1/apis/codefresh:codefresh-triggers-api"
All apis
curl "https://apis.io/api/v1/apis?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.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
name: Codefresh
url: https://www.codefresh.io
description: Codefresh API openAPI 3.0 specification
termsOfService: https://codefresh.io/docs/docs/terms-and-privacy-policy/terms-of-service/
title: Codefresh Triggers API
version: 0.0.2
x-logo:
url: https://g.codefresh.io/modules/cf.resources/codefresh-api-docs-images/codefresh-logo-api.svg
backgroundColor: '#FFFFFF'
altText: Codefresh
servers:
- url: https://g.codefresh.io/api
security:
- API-key: []
tags:
- name: Triggers
description: Only for registry, helm and cron triggers
x-id: triggers
paths:
/hermes/triggers:
get:
responses:
'200':
content:
application/json:
schema:
type: array
items:
properties:
event:
type: string
description: Event name - i.e. cron:codefresh:0 0/1 * 1/1 * *:test:2cf1fed*****
pipeline:
type: string
description: Pipeline id - i.e. 60098c2de8e*****
filters:
type: object
properties:
tag:
type: string
description: Filter tag - i.e. test
event-data:
type: object
properties:
account:
type: string
description: Account id - i.e. 59d37837920****
description:
type: string
description: Event description - i.e. JFrog Artifactory repository/chart push event
endpoint:
type: string
description: Event endpoint - i.e. https://g.codefresh.io/nomios/helm/jfrog?account=2cf1f*****&secret=Iq7uj9rL******
help:
type: string
description: Help message - i.e. JFrog Artifactory webhooks fire when an image is built in, pushed or a new tag is added to ...
secret:
type: string
description: Event secret - i.e. Iq7uj9******
status:
type: string
description: Event status - i.e. active
type:
type: string
description: Event type - i.e. helm
uri:
type: string
description: Event uri - i.e. helm:jfrog:repository:chart:push:2cf1f*****
examples:
successfulResponse:
summary: List of triggers (event data will not return with this request)
value:
- event: registry:dockerhub:org:repository:push:2cf1fed*****
pipeline: 60098c2de8e*****
filters:
tag: test
event-data:
uri: ''
type: ''
kind: ''
account: ''
secret: ''
- event: cron:codefresh:0 0/1 * 1/1 * *:test:2cf1fed*****
pipeline: 60098c2de8e*****
event-data:
uri: ''
type: ''
kind: ''
account: ''
secret: ''
- event: helm:jfrog:gfg:gfgf:push:2cf1fed*****
pipeline: 60098c2de8e*****
event-data:
uri: ''
type: ''
kind: ''
account: ''
secret: ''
description: json
tags:
- Triggers
operationId: triggers-list
parameters: []
summary: List of triggers
x-sdk-interface: triggers.list
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/triggers\""
- lang: node.js
source: sdk.triggers.list()
/hermes/triggers/event/{event}:
get:
responses:
'200':
content:
application/json:
schema:
properties:
event:
type: string
description: Event name - i.e. cron:codefresh:0 0/1 * 1/1 * *:test:2cf1fed*****
pipeline:
type: string
description: Pipeline id - i.e. 60098c2de8e*****
filters:
type: object
properties:
tag:
type: string
description: Filter tag - i.e. test
event-data:
type: object
properties:
account:
type: string
description: Account id - i.e. 59d37837920****
description:
type: string
description: Event description - i.e. JFrog Artifactory repository/chart push event
endpoint:
type: string
description: Event endpoint - i.e. https://g.codefresh.io/nomios/helm/jfrog?account=2cf1f*****&secret=Iq7uj9rL******
help:
type: string
description: Help message - i.e. JFrog Artifactory webhooks fire when an image is built in, pushed or a new tag is added to ...
secret:
type: string
description: Event secret - i.e. Iq7uj9******
status:
type: string
description: Event status - i.e. active
type:
type: string
description: Event type - i.e. helm
uri:
type: string
description: Event uri - i.e. helm:jfrog:repository:chart:push:2cf1f*****
examples:
successfulResponse:
summary: get trigger by event (event data will not return with this request)
value:
- event: registry:dockerhub:org:repository:push:2cf1fed*****
pipeline: 2cf1fed*****
filters:
tag: test
event-data:
uri: ''
type: ''
kind: ''
account: ''
secret: ''
description: json
tags:
- Triggers
operationId: triggers-get-event-triggers
parameters:
- in: path
name: event
schema:
type: string
required: true
description: Event name - i.e. registry:dockerhub:org:repository:push:2cf1fed*****
summary: Get trigger by event name
x-sdk-interface: triggers.getEventTriggers
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/triggers/event/${EVENT}\""
- lang: node.js
source: sdk.triggers.getEventTriggers({ event })
/hermes/triggers/pipeline/{pipeline}:
get:
responses:
'200':
content:
application/json:
schema:
properties:
event:
type: string
description: Event name - i.e. cron:codefresh:0 0/1 * 1/1 * *:test:2cf1fed*****
pipeline:
type: string
description: Pipeline id - i.e. 60098c2de8e*****
filters:
type: object
properties:
tag:
type: string
description: Filter tag - i.e. test
event-data:
type: object
properties:
account:
type: string
description: Account id - i.e. 59d37837920****
description:
type: string
description: Event description - i.e. JFrog Artifactory repository/chart push event
endpoint:
type: string
description: Event endpoint - i.e. https://g.codefresh.io/nomios/helm/jfrog?account=2cf1f*****&secret=Iq7uj9rL******
help:
type: string
description: Help message - i.e. JFrog Artifactory webhooks fire when an image is built in, pushed or a new tag is added to ...
secret:
type: string
description: Event secret - i.e. Iq7uj9******
status:
type: string
description: Event status - i.e. active
type:
type: string
description: Event type - i.e. helm
uri:
type: string
description: Event uri - i.e. helm:jfrog:repository:chart:push:2cf1f*****
examples:
successfulResponse:
summary: List of triggers for pipeline
value:
- event: cron:codefresh:0 0/1 * 1/1 * *:test:2cf1fed*****
pipeline: 60098c2de8e*****
event-data:
description: '2021-02-14T14:29:00Z'
status: active
help: 'Cronus cron event provider triggers Codefresh pipeline execution, following cron expression.
Supported cron expression syntax:
https://github.com/codefresh-io/cronus/blob/master/docs/expression.md'
uri: cron:codefresh:0 0/1 * 1/1 * *:test:2cf1fed*****
type: cron
kind: codefresh
account: 59d3783792*****
secret: Wjs1cCDZa92tAnBn
- event: helm:jfrog:gfg:gfgf:push:2cf1fed*****
pipeline: 60098c2de8e*****
event-data:
endpoint: https://g.codefresh.io/nomios/helm/jfrog?account=2cf1fed*****&secret=5X6iv9a******
description: JFrog Artifactory repository/chart push event
status: active
help: 'JFrog Artifactory webhooks fire when an image is built in, pushed or a new tag is added to, your repository.
Configure JFrog Artifactory on https://codefresh.io/docs/docs/configure-ci-cd-pipeline/triggers/jfrog-triggers/
Add following Codefresh JFrog Artifactory webhook endpoint https://g.codefresh.io/nomios/helm/jfrog?account=2cf1fed*****&secret=5X6iv9a******'
uri: helm:jfrog:gfg:gfgf:push:2cf1fed*****
type: helm
kind: jfrog
account: 59d3783792*****
secret: 5X6iv9a******
- event: registry:dockerhub:org:repository:push:2cf1fed*****
pipeline: 60098c2de8e*****
filters:
tag: test
event-data:
endpoint: https://g.codefresh.io/nomios/dockerhub?account=2cf1fed*****&secret=fSbFkp3Pp*****
description: Docker Hub org/repository push event
status: active
help: 'Docker Hub webhooks fire when an image is built in, pushed or a new tag is added to, your repository.
Configure Docker Hub on https://hub.docker.com/r/org/repository/~/settings/webhooks/
Add following Codefresh Docker Hub webhook endpoint https://g.codefresh.io/nomios/dockerhub?account=2cf1fed*****&secret=fSbFkp3Pp*****'
uri: registry:dockerhub:org:repository:push:2cf1fed*****
type: registry
kind: dockerhub
account: 59d3783792*****
secret: fSbFkp3Pp*****
description: json
tags:
- Triggers
operationId: triggers-get-pipeline-triggers
parameters:
- in: path
name: pipeline
schema:
type: string
required: true
description: Pipeline id
- in: query
name: with-event
schema:
type: boolean
description: if true the response will include event data
summary: List of pipeline triggers
x-sdk-interface: triggers.getPipelineTriggers
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/triggers/pipeline/${PIPELINE}?with-event=${WITH_EVENT}\""
- lang: node.js
source: sdk.triggers.getPipelineTriggers({ pipeline, with-event })
/hermes/triggers/{event}/{pipeline}:
post:
x-action: createTrigger
x-entityId: params.pipeline
responses:
'200':
content:
application/json:
schema:
type: object
description: json
tags:
- Triggers
operationId: triggers-create
parameters:
- in: path
name: event
schema:
type: string
required: true
description: Event name - i.e. registry:dockerhub:org:repository:push:2cf1fed*****
- in: path
name: pipeline
schema:
type: string
required: true
description: Pipeline id
requestBody:
content:
application/json:
schema:
type: object
summary: Create new trigger for pipeline
description: 'NOTE: ''event'' parameter should be url-encoded TWICE!'
x-sdk-interface: triggers.create
x-code-samples:
- lang: curl
source: "curl \\\n -X POST \\\n -H \"Authorization: ${API_KEY}\" \\\n -H 'Content-Type: application/json; charset=utf-8' \\\n -d \"${REQUEST_BODY_OBJ}\" \\\n \"https://g.codefresh.io/api/hermes/triggers/${EVENT}/${PIPELINE}\""
- lang: node.js
source: sdk.triggers.create({ event, pipeline }, { ...REQUEST_BODY_OBJ })
delete:
x-action: deleteTrigger
x-entityId: params.pipeline
responses:
'200':
content:
application/json:
schema:
type: object
description: json
tags:
- Triggers
operationId: triggers-delete
parameters:
- in: path
name: event
schema:
type: string
required: true
description: Event name - i.e. registry:dockerhub:org:repository:push:2cf1fed*****
- in: path
name: pipeline
schema:
type: string
required: true
description: Pipeline id
summary: Delete trigger from pipeline
description: 'NOTE: ''event'' parameter should be url-encoded TWICE!'
x-sdk-interface: triggers.delete
x-code-samples:
- lang: curl
source: "curl \\\n -X DELETE \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/triggers/${EVENT}/${PIPELINE}\""
- lang: node.js
source: sdk.triggers.delete({ event, pipeline })
/pipelines/invalidTriggers:
get:
parameters: []
responses:
'200':
description: Retrieve all incorrectly configured triggers of pipelines for the account
content:
application/json:
schema:
type: object
example:
- id: 63e91e72714b6771bc36680c
name: test-trigger
context: github
provider: github
repo: test/test
pipelineName: test-pipeline
tags:
- Triggers
operationId: pipelines-invalid-triggers
summary: Retrieve all incorrectly configured triggers of pipelines for the account
x-sdk-interface: pipelines.getInvalidTriggers
x-endpoint:
isEndpoint: false
auth:
middleware:
- auth.isAuthenticated
acl:
resource: pipeline
postMiddleware:
- global.iseMiddleware
handler: pipelines.getAllInvalidTriggers
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/pipelines/invalidTriggers\""
- lang: node.js
source: sdk.pipelines.getInvalidTriggers()
put:
x-action: resolveAllInvalidTriggers
parameters: []
responses:
'200':
description: Resolve all incorrectly configured triggers for the account's pipelines
content:
application/json:
schema:
type: object
example:
failed: []
succeed:
- repo: test/test
pipelineName: test-pipeline
triggerId: 63e91e72714b6771bc36680c
'400':
description: Failed to resolve all incorrectly configured triggers for the account's pipelines
content:
application/json:
schema:
type: object
example:
failed:
- repo: test/test
pipelineName: test-pipeline
triggerId: 63e91e72714b6771bc36680c
error: 'Error: required object not found'
succeed: []
tags:
- Triggers
operationId: pipelines-resolve-invalid-trigger
summary: Resolve all incorrectly configured triggers for the account's pipelines
x-sdk-interface: pipelines.resolveInvalidTriggers
x-endpoint:
isEndpoint: false
auth:
middleware:
- auth.isAuthenticated
acl:
resource: pipeline
abac: true
postMiddleware:
- global.iseMiddleware
handler: pipelines.resolveAllInvalidTriggers
x-code-samples:
- lang: curl
source: "curl \\\n -X PUT \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/pipelines/invalidTriggers\""
- lang: node.js
source: sdk.pipelines.resolveInvalidTriggers()
/pipelines/triggers:
get:
parameters: []
responses:
'200':
description: Retrieve all triggers of pipelines for the account
content:
application/json:
schema:
type: object
example:
- id: 63e91e72714b6771bc36680c
name: test-trigger
context: github
provider: github
repo: test/test
pipelineName: test-pipeline
- id: 63e91e72714b6771bc36680d
name: test-trigger2
context: github
provider: github
repo: test/test2
pipelineName: test-pipeline2
tags:
- Triggers
operationId: pipelines-get-all-triggers
summary: Retrieve all triggers of pipelines for the account
x-sdk-interface: pipelines.getAllTriggers
x-endpoint:
isEndpoint: false
auth:
middleware:
- auth.isAuthenticated
acl:
resource: pipeline
postMiddleware:
- global.iseMiddleware
handler: pipelines.getAllAccountPipelinesTriggers
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/pipelines/triggers\""
- lang: node.js
source: sdk.pipelines.getAllTriggers()
components:
securitySchemes:
API-key:
in: header
name: Authorization
description: 'An api key got from: User Settings -> API keys -> Generate'
type: apiKey
x-service-name: api-public
x-base-path: /api
x-internal-services:
- pipeline-manager
- api
x-endpoint-conditions:
- weight: 0
condition: global.has-general-service-role
handlerRegex: (.*)
- weight: 1
condition: global.has-kubernetes-endpoints-service-role
handlerRegex: kubernetes\.\w+
- weight: 2
condition: global.has-auth-service-role
handlerRegex: api-key\.\w+
x-tagGroups:
- name: Pipelines / Builds
tags:
- Annotations
- Builds
- Execution Contexts
- Images
- Pipelines
- Progress
- Projects
- Step-types
- Triggers
- Triggers Events
- Triggers Types
- name: Kubernetes / Helm
tags:
- Environments V2
- Helm Boards
- Helm Charts
- Helm Releases
- Helm Sections
- Kubernetes
- name: Swarm
tags:
- Compositions
- Environments
- name: Integrations / Contexts
tags:
- Clusters
- Contexts
- Helm Cluster Configs
- Helm Repos
- Registries
- Repos
- name: Account Management
tags:
- Abac
- Accounts
- Agents
- Audit
- Runtime Environments
- Teams
- Tokens
- Views
- name: User Properties
tags:
- favorites
- name: On-Premise
tags:
- Features
- Runtime Environments (Account)
- Runtime Environments (Plan)
- Runtime Environments (System)
- Runtime Environments.
- name: Platform Analytics
tags:
# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-triggers-api-openapi.yml