Sign in
Deployment Triggers

Create a deployment trigger

Creates a deployment trigger that runs a check (or check group) whenever the linked GitHub repository reports a successful deployment. Set useEnvironmentUrl to run against the deployment’s environment_url, and environmentRegexFilter to restrict which environments trigger a run. Idempotent per check/group: a trigger that already exists for the same target is returned unchanged.

post/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

Request body

checkIdstring nullable

The ID of the check to run on deploy.

groupIdnumber nullable

The ID of the check group to run on deploy.

repoNamestring required

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

repoLinkstring

A link to the repository.

useEnvironmentUrlboolean

Run the check against the deployment’s environment_url instead of its own target. API and URL checks get their host swapped; browser and multi-step checks receive it as the ENVIRONMENT_URL environment variable.

includeScreenshotsboolean

Attach screenshots to the check run posted back to the commit.

provider'GITHUB'

The deployment provider. Only GITHUB is supported.

runLocation'us-east-1' | 'us-east-2' | 'us-west-1' | 'us-west-2' | 'ca-central-1' | 'sa-east-1' | 'eu-west-1' | 'eu-central-1' | 'eu-west-2' | 'eu-west-3' | 'eu-north-1' | 'eu-south-1' | 'me-south-1' | 'ap-southeast-1' | 'ap-northeast-1' | 'ap-east-1' | 'ap-southeast-2' | 'ap-southeast-3' | 'ap-northeast-2' | 'ap-northeast-3' | 'ap-south-1' | 'af-south-1'

The region the triggered run executes in.

environmentRegexFilterstring nullable

Only deployments whose environment name matches this regular expression trigger a run, e.g. ^(?:Preview|staging)$.

environmentUrlRegexFilterstring nullable

Only deployments whose environment URL matches this regular expression trigger a run.

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