Checkly · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Checkly Public Triggers API
10 actions
10 updates
phrasing
extends
openapi/checkly-triggers-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Checkly's API. It is a proposal applied on top of the contract, not a document Checkly publishes.
What the actions change
x-apievangelist-phrasing
Targets 10
$.info
$.paths['/v1/check-sessions/trigger'].post
$.paths['/v1/test-sessions/trigger'].post
$.paths['/v1/triggers/check-groups/{groupId}'].get
$.paths['/v1/triggers/check-groups/{groupId}'].post
$.paths['/v1/triggers/check-groups/{groupId}'].delete
$.paths['/v1/triggers/checks/{checkId}'].get
$.paths['/v1/triggers/checks/{checkId}'].post
$.paths['/v1/triggers/checks/{checkId}'].delete
$.paths['/v2/check-sessions/trigger'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Checkly Public Triggers API
version: 1.0.0
extends: openapi/checkly-triggers-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 9
- target: $.paths['/v1/check-sessions/trigger'].post
update:
x-apievangelist-phrasing:
intent: Start check sessions for matching checks (v1)
effect: write
questions:
- How do I run my checks on demand right now through the original v1 trigger?
- What happens with the v1 check session trigger if I give no target filters?
instructions:
- text: Trigger a v1 check session for checks matching {target}.
slots:
target: requestBody.target
- text: Start v1 check sessions for every eligible check.
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/test-sessions/trigger'].post
update:
x-apievangelist-phrasing:
intent: Trigger a test session
effect: write
questions:
- Can I kick off a named test run of my checks from a chosen location?
- Does triggering a test session wait for the results before returning?
instructions:
- text: Trigger test session {name} in {runLocation}.
slots:
name: requestBody.name
runLocation: requestBody.runLocation
- text: Start test session {name} from {runLocation} for checks matching {target}.
slots:
name: requestBody.name
runLocation: requestBody.runLocation
target: requestBody.target
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/triggers/check-groups/{groupId}'].get
update:
x-apievangelist-phrasing:
intent: Get a check group's trigger URL (deprecated)
effect: read
questions:
- What is the deprecated trigger URL for one of my check groups?
- Does my check group already have a trigger set up?
instructions:
- text: Show the trigger for check group {groupId}.
slots:
groupId: path.groupId
- text: Get the deprecated trigger URL of group {groupId}.
slots:
groupId: path.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/triggers/check-groups/{groupId}'].post
update:
x-apievangelist-phrasing:
intent: Create a check group trigger (deprecated)
effect: write
questions:
- Can I create a URL that runs a whole check group when called?
- Is creating a check group trigger still supported?
instructions:
- text: Create a trigger for check group {groupId}.
slots:
groupId: path.groupId
- text: Generate a deprecated trigger URL for group {groupId}.
slots:
groupId: path.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/triggers/check-groups/{groupId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a check group trigger (deprecated)
effect: destructive
questions:
- How do I remove the trigger from a check group?
- Can I revoke a check group's trigger URL so it no longer runs the group?
instructions:
- text: Delete the trigger on check group {groupId}.
slots:
groupId: path.groupId
- text: Revoke check group {groupId}'s trigger URL.
slots:
groupId: path.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/triggers/checks/{checkId}'].get
update:
x-apievangelist-phrasing:
intent: Get a check's trigger URL (deprecated)
effect: read
questions:
- What is the trigger URL for a single check?
- Does this individual check have a trigger configured?
instructions:
- text: Show the trigger for check {checkId}.
slots:
checkId: path.checkId
- text: Get the deprecated trigger URL of check {checkId}.
slots:
checkId: path.checkId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/triggers/checks/{checkId}'].post
update:
x-apievangelist-phrasing:
intent: Create a check trigger (deprecated)
effect: write
questions:
- Can I get a URL that runs one specific check when called?
- Is creating a trigger for a single check still possible?
instructions:
- text: Create a trigger for check {checkId}.
slots:
checkId: path.checkId
- text: Generate a deprecated trigger URL for check {checkId}.
slots:
checkId: path.checkId
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/triggers/checks/{checkId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a check trigger (deprecated)
effect: destructive
questions:
- How do I remove a single check's trigger?
- Can I revoke the trigger URL of one check?
instructions:
- text: Delete the trigger on check {checkId}.
slots:
checkId: path.checkId
- text: Revoke check {checkId}'s trigger URL.
slots:
checkId: path.checkId
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/check-sessions/trigger'].post
update:
x-apievangelist-phrasing:
intent: Start check sessions for matching checks (v2)
effect: write
questions:
- Which endpoint triggers check sessions under the v2 API?
- Can I refresh the cache when triggering v2 check sessions?
instructions:
- text: Trigger a v2 check session for checks matching {target}.
slots:
target: requestBody.target
- text: Start v2 check sessions for checks matching {target} with cache refresh set to {refreshCache}.
slots:
target: requestBody.target
refreshCache: requestBody.refreshCache
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay 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 openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay 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 overlay
curl "https://apis.io/api/v1/overlays/checkly-triggers-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.