Sign in
Deployment Triggers

List all deployment triggers

Lists all deployment triggers in your account.

get/v1/deployment-triggers

Headers

x-checkly-accountstring

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

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

Response

Successful

idnumber

The deployment trigger ID.

checkIdstring nullable

The check this trigger runs.

groupIdnumber nullable

The check group this trigger runs.

providerstring

The deployment provider. Always GITHUB for this endpoint.

repoIdstring

The provider-side repository ID.

repoNamestring

The repository name, e.g. acme/storefront.

repoLinkstring nullable

A link to the repository.

useEnvironmentUrlboolean

Whether the deployment’s environment_url is injected into the run.

includeScreenshotsboolean

Whether screenshots are attached to the posted check run.

environmentRegexFilterstring nullable

Only deployments whose environment name matches this regex trigger a run.

environmentUrlRegexFilterstring nullable

Only deployments whose environment URL matches this regex trigger a run.

runLocationstring

The region the triggered run executes in.

created_atstring date
updated_atstring date nullable

Changes

Changed in 1 of the 4 revisions of this API.1