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-events-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 Events 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 Events
description: triggers.events
x-id: triggers.events
paths:
/hermes/events:
post:
responses:
'200':
description: Successful creation of event
content:
application/json:
schema:
type: string
example: registry:dockerhub:myaccount:hello:push:c2311e92660d
tags:
- Triggers Events
operationId: triggers-events-create
parameters:
- in: query
name: public
schema:
type: string
description: 'create public trigger if specified: true'
- in: query
name: pipeline
schema:
type: string
description: The pipeline for which the event is created
requestBody:
content:
application/json:
schema:
properties:
type:
type: string
example: registry
description: Trigger type
kind:
type: string
example: dockerhub
description: Kind of trigger type
filter:
type: string
default: ''
secret:
type: string
default: '!generate'
description: secret is required, `!generate` can be provide for auto generation
values:
type: object
properties:
namespace:
type: string
description: Account context
name:
type: string
description: 'Full pipeline name including project: {project}/{pipeline}'
action:
type: string
default: push
type: object
summary: Create a trigger-event, trigger-event provides a webhook for triggering a…
description: Create a trigger-event entity. The trigger-event entity is used for triggering a workflow (using account context as 'namespace' and {project}/{pipeline} as name). This entity has an endpoint field that holds the trigger's webhook
x-sdk-interface: triggers.events.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 \"{\\\"type\\\":\\\"${TYPE_STR}\\\",\\\"kind\\\":\\\"${KIND_STR}\\\",\\\"filter\\\":\\\"${FILTER_STR}\\\",\\\"secret\\\":\\\"${SECRET_STR}\\\",\\\"values\\\":{\\\"namespace\\\":\\\"${NAMESPACE_STR}\\\",\\\"name\\\":\\\"${NAME_STR}\\\",\\\"action\\\":\\\"${ACTION_STR}\\\"}}\" \\\n \"https://g.codefresh.io/api/hermes/events?public=${PUBLIC}&pipeline=${PIPELINE}\""
- lang: node.js
source: "sdk.triggers.events.create({ public, pipeline }, {\n type: `${TYPE_STR}`,\n kind: `${KIND_STR}`,\n filter: `${FILTER_STR}`,\n secret: `${SECRET_STR}`,\n values: {\n namespace: `${NAMESPACE_STR}`,\n name: `${NAME_STR}`,\n action: `${ACTION_STR}`\n }\n})"
get:
responses:
'200':
description: List of event-triggers
content:
application/json:
schema:
type: array
items:
properties:
endpoint:
type: string
uri:
type: string
type:
type: string
kind:
type: string
account:
type: string
secret:
type: string
example:
- endpoint: https://g.codefresh.io/nomios/dockerhub?account=1e88****&secret=sBdW****
description: Docker Hub mydhuccount/hello 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/mydhuccount/hello/~/settings/webhooks/
Add following Codefresh Docker Hub webhook endpoint https://g.codefresh.io/nomios/dockerhub?account=1e88****&secret=sBdW****'
uri: registry:dockerhub:mydhuccount:hello:push:1e88****
type: registry
kind: dockerhub
account: 5e7c****
secret: sBdW****
- endpoint: https://g.codefresh.io/nomios/dockerhub?account=1e88****&secret=Tg2D****
description: Docker Hub mydhuccount/ui-api 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/mydhuccount/ui-api/~/settings/webhooks/
Add following Codefresh Docker Hub webhook endpoint https://g.codefresh.io/nomios/dockerhub?account=1e88****&secret=Tg2D****'
uri: registry:dockerhub:mydhuccount:ui-api:push:1e88****
type: registry
kind: dockerhub
account: 5e7c****
secret: Tg2D****
tags:
- Triggers Events
operationId: triggers-events-list
parameters:
- in: query
name: type
schema:
type: string
example: registry
description: optional i.e ?type=registry
- in: query
name: kind
schema:
type: string
example: dockerhub
description: optional i.e ?kind=dockerhub
- in: query
name: filter
schema:
type: string
description: optional i.e. ?filter=filterMyRepoTag
- in: query
name: public
schema:
type: boolean
example: 'true'
description: optional i.e. ?public=true
description: 'Provides trigger events, can be filtered by Type/Kind/Public. see: /event/types'
summary: List trigger-events
x-sdk-interface: triggers.events.list
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/events?type=${TYPE}&kind=${KIND}&filter=${FILTER}&public=${PUBLIC}\""
- lang: node.js
source: "sdk.triggers.events.list({\n type,\n kind,\n filter,\n public\n})"
/hermes/events/{event}:
get:
responses:
'200':
description: Get event-trigger. get /hermes/events/registry:dockerhub:mydhuccount:hello:push:1e88****
content:
application/json:
schema:
properties:
endpoint:
type: string
uri:
type: string
type:
type: string
kind:
type: string
account:
type: string
secret:
type: string
example:
endpoint: https://g.codefresh.io/nomios/dockerhub?account=1e88****&secret=sBdW****
description: Docker Hub mydhuccount/hello 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/mydhuccount/hello/~/settings/webhooks/
Add following Codefresh Docker Hub webhook endpoint https://g.codefresh.io/nomios/dockerhub?account=1e88****&secret=sBdW****'
uri: registry:dockerhub:mydhuccount:hello:push:1e88****
type: registry
kind: dockerhub
account: 5e7c****
secret: sBdW****
tags:
- Triggers Events
operationId: triggers-events-get
parameters:
- in: path
name: event
schema:
type: string
required: true
description: 'Event i.e. registry:dockerhub:myaccount:hello:push:c2311e92660d '
summary: Get
x-sdk-interface: triggers.events.get
x-code-samples:
- lang: curl
source: "curl \\\n -X GET \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/events/${EVENT}\""
- lang: node.js
source: sdk.triggers.events.get({ event })
/hermes/events/{event}/{context}:
delete:
responses:
'200':
description: Successful delete of trigger event
content:
application/json:
schema:
type: string
example: ''
'500':
description: Error response - can't delete if not found.
content:
application/json:
schema:
type: object
example:
status: 500
message: failed to delete trigger event
error: trigger event not found
tags:
- Triggers Events
operationId: triggers-events-delete
parameters:
- in: path
name: event
schema:
type: string
required: true
description: Event
- in: path
name: context
schema:
type: string
required: true
description: Context
summary: Delete
description: Delete a trigger-event by specified 'event' identifier
x-sdk-interface: triggers.events.delete
x-code-samples:
- lang: curl
source: "curl \\\n -X DELETE \\\n -H \"Authorization: ${API_KEY}\" \\\n \"https://g.codefresh.io/api/hermes/events/${EVENT}/${CONTEXT}\""
- lang: node.js
source: sdk.triggers.events.delete({ event, context })
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 (137 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/codefresh/refs/heads/main/openapi/codefresh-triggers-events-api-openapi.yml