How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Checkly Triggers API

The Triggers API from Checkly — 9 operation(s) for triggers.

Checkly Triggers API is one of 42 APIs that Checkly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Triggers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 5 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.checklyhq.com.

9 operations 5 paths 34 schemas 2 DELETE2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.checklyhq.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Checkly Triggers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer) (Bearer). By default, every request must be authenticated.

  • Bearer — The Checkly Public API uses API keys to authenticate requests. You can get the API Key here . Your API key is like a password: keep it secure! Authentication t…

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 2 DELETE, 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Triggers 9
POST
/v1/check-sessions/triggerdeprecated
Trigger a new check session
postV1ChecksessionsTrigger body → 201401402403404429
POST
/v1/test-sessions/trigger
Trigger a new test session
postV1TestsessionsTrigger 1 param body → 201400401402403404429
DELETE
/v1/triggers/check-groups/{groupId}deprecated
Delete the check group trigger
deleteV1TriggersCheckgroupsGroupid 2 params → 204401403429
GET
/v1/triggers/check-groups/{groupId}deprecated
Get the check group trigger
getV1TriggersCheckgroupsGroupid 2 params → 200401403429
POST
/v1/triggers/check-groups/{groupId}deprecated
Create the check group trigger
postV1TriggersCheckgroupsGroupid 2 params → 201401403429
DELETE
/v1/triggers/checks/{checkId}deprecated
Delete the check trigger
deleteV1TriggersChecksCheckid 2 params → 204401403429
GET
/v1/triggers/checks/{checkId}deprecated
Get the check trigger
getV1TriggersChecksCheckid 2 params → 200401403429
POST
/v1/triggers/checks/{checkId}deprecated
Create the check trigger
postV1TriggersChecksCheckid 2 params → 201401403429
POST
/v2/check-sessions/trigger
Trigger a new check session
postV2ChecksessionsTrigger 1 param body → 201400401402403404429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are TestSessionResult (16 properties), TestSessionGitHubMetadata (12 properties), CheckSessionsV2CheckSession (11 properties), CheckSession (11 properties). Each schema is shown below with its type and property counts.

attributes
object
TriggerCheckSessionResponse
object
Returns a check session for each check matching target conditions.
1 property 1 required
TriggerCheckSessionRequestPayload
object
2 properties
TestSessionEnvironmentVariable
checkId
array
Match checks with the given identifiers.
Model23
array
Model2
string
TooManyRequestsError
object
4 properties 2 required
UnauthorizedError
object
4 properties 2 required
Model24
string
CheckSessionsV2CheckSession
object
11 properties 10 required
PaymentRequiredError
object
4 properties 2 required
TestSessionGitHubMetadata
object
12 properties 1 required
Model25
string
The status of the check session.
runLocations
array
The run locations of the check session.
NoMatchingChecksFoundErrorResponse
object
Returned when there are no matching checks.
3 properties 1 required
sessions
array
A list of check sessions, with one check session for each check.
runSource
stringnull
The source that triggered the check session.
ForbiddenError
object
3 properties 2 required
TestSessionMetadata
object
7 properties
TestSessionResult
object
16 properties 9 required
CheckGroupTrigger
object
6 properties 4 required
ApiError
object
3 properties 3 required
TriggerTestSessionResponse
object
10 properties 7 required
CheckSession
object
11 properties 8 required
CheckTrigger
object
6 properties 4 required
Model3
string
matchTags
array
Match checks with the given tags. Group tags also match. The value is a two-dimensional array. The top level array defines OR conditions, and the second level…
error
string
CheckSessionsV2TriggerRequest
object
2 properties
TriggerTestSessionRequest
object
7 properties 2 required
TriggerCheckSessionTarget
object
2 properties
Model1
string
CheckSessionsV2TriggerResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

checkly-triggers-api-openapi.yml Raw ↑

Other APIs Checkly publishes across the network.

Checkly Accounts API
Checkly Alert Channels API
Checkly Analytics API
Checkly Check Alerts API
Checkly Check Groups API
Checkly Check Results API
Checkly Checks API
Checkly Dashboards API
Checkly Heartbeats API
Checkly Incidents API
Checkly Maintenance Windows API
Where this information came from

This is an independent, third-party profile of Checkly Triggers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.