Create a deployment trigger

curl --request POST \
  --url https://api.checklyhq.com/v1/deployment-triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repoId": 123,
  "repoName": "<string>",
  "checkId": "<string>",
  "groupId": 123,
  "repoLink": "",
  "useEnvironmentUrl": true,
  "includeScreenshots": false,
  "provider": "GITHUB",
  "runLocation": "us-east-1",
  "environmentRegexFilter": null,
  "environmentUrlRegexFilter": null
}
'

import requests

url = "https://api.checklyhq.com/v1/deployment-triggers"

payload = {
    "repoId": 123,
    "repoName": "<string>",
    "checkId": "<string>",
    "groupId": 123,
    "repoLink": "",
    "useEnvironmentUrl": True,
    "includeScreenshots": False,
    "provider": "GITHUB",
    "runLocation": "us-east-1",
    "environmentRegexFilter": None,
    "environmentUrlRegexFilter": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    repoId: 123,
    repoName: '<string>',
    checkId: '<string>',
    groupId: 123,
    repoLink: '',
    useEnvironmentUrl: true,
    includeScreenshots: false,
    provider: 'GITHUB',
    runLocation: 'us-east-1',
    environmentRegexFilter: null,
    environmentUrlRegexFilter: null
  })
};

fetch('https://api.checklyhq.com/v1/deployment-triggers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v1/deployment-triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'repoId' => 123,
    'repoName' => '<string>',
    'checkId' => '<string>',
    'groupId' => 123,
    'repoLink' => '',
    'useEnvironmentUrl' => true,
    'includeScreenshots' => false,
    'provider' => 'GITHUB',
    'runLocation' => 'us-east-1',
    'environmentRegexFilter' => null,
    'environmentUrlRegexFilter' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checklyhq.com/v1/deployment-triggers"

	payload := strings.NewReader("{\n  \"repoId\": 123,\n  \"repoName\": \"<string>\",\n  \"checkId\": \"<string>\",\n  \"groupId\": 123,\n  \"repoLink\": \"\",\n  \"useEnvironmentUrl\": true,\n  \"includeScreenshots\": false,\n  \"provider\": \"GITHUB\",\n  \"runLocation\": \"us-east-1\",\n  \"environmentRegexFilter\": null,\n  \"environmentUrlRegexFilter\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.checklyhq.com/v1/deployment-triggers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repoId\": 123,\n  \"repoName\": \"<string>\",\n  \"checkId\": \"<string>\",\n  \"groupId\": 123,\n  \"repoLink\": \"\",\n  \"useEnvironmentUrl\": true,\n  \"includeScreenshots\": false,\n  \"provider\": \"GITHUB\",\n  \"runLocation\": \"us-east-1\",\n  \"environmentRegexFilter\": null,\n  \"environmentUrlRegexFilter\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v1/deployment-triggers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"repoId\": 123,\n  \"repoName\": \"<string>\",\n  \"checkId\": \"<string>\",\n  \"groupId\": 123,\n  \"repoLink\": \"\",\n  \"useEnvironmentUrl\": true,\n  \"includeScreenshots\": false,\n  \"provider\": \"GITHUB\",\n  \"runLocation\": \"us-east-1\",\n  \"environmentRegexFilter\": null,\n  \"environmentUrlRegexFilter\": null\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "checkId": "<string>",
  "groupId": 123,
  "provider": "<string>",
  "repoId": "<string>",
  "repoName": "<string>",
  "repoLink": "<string>",
  "useEnvironmentUrl": true,
  "includeScreenshots": true,
  "environmentRegexFilter": "<string>",
  "environmentUrlRegexFilter": "<string>",
  "runLocation": "<string>",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

{
  "id": 123,
  "checkId": "<string>",
  "groupId": 123,
  "provider": "<string>",
  "repoId": "<string>",
  "repoName": "<string>",
  "repoLink": "<string>",
  "useEnvironmentUrl": true,
  "includeScreenshots": true,
  "environmentRegexFilter": "<string>",
  "environmentUrlRegexFilter": "<string>",
  "runLocation": "<string>",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Bad Token",
  "attributes": {}
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Not Found"
}

POST

deployment-triggers

Create a deployment trigger

curl --request POST \
  --url https://api.checklyhq.com/v1/deployment-triggers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repoId": 123,
  "repoName": "<string>",
  "checkId": "<string>",
  "groupId": 123,
  "repoLink": "",
  "useEnvironmentUrl": true,
  "includeScreenshots": false,
  "provider": "GITHUB",
  "runLocation": "us-east-1",
  "environmentRegexFilter": null,
  "environmentUrlRegexFilter": null
}
'

import requests

url = "https://api.checklyhq.com/v1/deployment-triggers"

payload = {
    "repoId": 123,
    "repoName": "<string>",
    "checkId": "<string>",
    "groupId": 123,
    "repoLink": "",
    "useEnvironmentUrl": True,
    "includeScreenshots": False,
    "provider": "GITHUB",
    "runLocation": "us-east-1",
    "environmentRegexFilter": None,
    "environmentUrlRegexFilter": None
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    repoId: 123,
    repoName: '<string>',
    checkId: '<string>',
    groupId: 123,
    repoLink: '',
    useEnvironmentUrl: true,
    includeScreenshots: false,
    provider: 'GITHUB',
    runLocation: 'us-east-1',
    environmentRegexFilter: null,
    environmentUrlRegexFilter: null
  })
};

fetch('https://api.checklyhq.com/v1/deployment-triggers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.checklyhq.com/v1/deployment-triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'repoId' => 123,
    'repoName' => '<string>',
    'checkId' => '<string>',
    'groupId' => 123,
    'repoLink' => '',
    'useEnvironmentUrl' => true,
    'includeScreenshots' => false,
    'provider' => 'GITHUB',
    'runLocation' => 'us-east-1',
    'environmentRegexFilter' => null,
    'environmentUrlRegexFilter' => null
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.checklyhq.com/v1/deployment-triggers"

	payload := strings.NewReader("{\n  \"repoId\": 123,\n  \"repoName\": \"<string>\",\n  \"checkId\": \"<string>\",\n  \"groupId\": 123,\n  \"repoLink\": \"\",\n  \"useEnvironmentUrl\": true,\n  \"includeScreenshots\": false,\n  \"provider\": \"GITHUB\",\n  \"runLocation\": \"us-east-1\",\n  \"environmentRegexFilter\": null,\n  \"environmentUrlRegexFilter\": null\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.checklyhq.com/v1/deployment-triggers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repoId\": 123,\n  \"repoName\": \"<string>\",\n  \"checkId\": \"<string>\",\n  \"groupId\": 123,\n  \"repoLink\": \"\",\n  \"useEnvironmentUrl\": true,\n  \"includeScreenshots\": false,\n  \"provider\": \"GITHUB\",\n  \"runLocation\": \"us-east-1\",\n  \"environmentRegexFilter\": null,\n  \"environmentUrlRegexFilter\": null\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.checklyhq.com/v1/deployment-triggers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"repoId\": 123,\n  \"repoName\": \"<string>\",\n  \"checkId\": \"<string>\",\n  \"groupId\": 123,\n  \"repoLink\": \"\",\n  \"useEnvironmentUrl\": true,\n  \"includeScreenshots\": false,\n  \"provider\": \"GITHUB\",\n  \"runLocation\": \"us-east-1\",\n  \"environmentRegexFilter\": null,\n  \"environmentUrlRegexFilter\": null\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "checkId": "<string>",
  "groupId": 123,
  "provider": "<string>",
  "repoId": "<string>",
  "repoName": "<string>",
  "repoLink": "<string>",
  "useEnvironmentUrl": true,
  "includeScreenshots": true,
  "environmentRegexFilter": "<string>",
  "environmentUrlRegexFilter": "<string>",
  "runLocation": "<string>",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

{
  "id": 123,
  "checkId": "<string>",
  "groupId": 123,
  "provider": "<string>",
  "repoId": "<string>",
  "repoName": "<string>",
  "repoLink": "<string>",
  "useEnvironmentUrl": true,
  "includeScreenshots": true,
  "environmentRegexFilter": "<string>",
  "environmentUrlRegexFilter": "<string>",
  "runLocation": "<string>",
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Bad Token",
  "attributes": {}
}

{
  "statusCode": 403,
  "error": "Forbidden",
  "message": "Forbidden"
}

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Not Found"
}

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

Body

application/json

repoId

required

The provider-side repository ID, e.g. GitHub’s numeric id.

repoName

string

required

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

checkId

string | null

The ID of the check to run on deploy.

groupId

number | null

The ID of the check group to run on deploy.

repoLink

string

default:""

A link to the repository.

useEnvironmentUrl

boolean

default:true

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.

includeScreenshots

boolean

default:false

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

provider

enum<string>

default:GITHUB

The deployment provider. Only GITHUB is supported.

Available options:

GITHUB

runLocation

enum<string>

default:us-east-1

The region the triggered run executes in.

Available options:

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

environmentRegexFilter

string | null

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

Maximum string length: 255

environmentUrlRegexFilter

string | null

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

Maximum string length: 255

Response

Successful

number

The deployment trigger ID.

checkId

string | null

The check this trigger runs.

groupId

number | null

The check group this trigger runs.

provider

string

The deployment provider. Always GITHUB for this endpoint.

repoId

string

The provider-side repository ID.

repoName

string

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

repoLink

string | null

A link to the repository.

useEnvironmentUrl

boolean

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

includeScreenshots

boolean

Whether screenshots are attached to the posted check run.

environmentRegexFilter

string | null

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

environmentUrlRegexFilter

string | null

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

runLocation

string

The region the triggered run executes in.

created_at

string<date>

updated_at

string<date> | null

List deployment triggers

⌘I

Getting Started

API Reference

Create a deployment trigger

Authorizations

Headers

Body

Response