POST
/
v1
/
triggers
/
check-groups
/
{groupId}
Create the check group trigger
curl --request POST \
  --url https://api.checklyhq.com/v1/triggers/check-groups/{groupId} \
  --header 'Authorization: <api-key>'
{
  "id": 1,
  "token": "h7QMmh8c0hYw",
  "created_at": "2023-12-25",
  "called_at": "2023-12-25",
  "updated_at": "2023-12-25",
  "groupId": 1
}

​
Overview

The Trigger Group Execution endpoint allows you to manually execute all checks within a specific check group. This is useful for comprehensive testing of related services and batch validation. Common Use Cases:
  • Group Testing
  • Service Validation
  • Deployment Testing
  • Batch Health Checks
Group triggers execute all checks in the group simultaneously. This may result in multiple check executions and count toward your account’s execution limits.

Authorizations

​
Authorization
string
header
required

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 to the API is performed using the Bearer auth method in the Authorization header and using the account ID.

For example, set Authorization header while using cURL:

curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Path Parameters

​
groupId
integer
required

Response

Created

​
id
number
required
Example:

1

​
token
string
required
Example:

"h7QMmh8c0hYw"

​
created_at
string<date>
required
​
groupId
number
required
Example:

1

​
called_at
string<date>
​
updated_at
string<date>