Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
openapi: post /v1/deployment-triggers
title: Create a deployment trigger
sidebarTitle: Create a trigger
description: Create a GitHub deployment trigger for a Checkly check or check group.
canonical: 'https://www.checklyhq.com/docs/api-reference/deployment-triggers/create-a-deployment-trigger/'
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
openapi: get /v1/deployment-triggers
title: List deployment triggers
sidebarTitle: List triggers
description: List the GitHub deployment triggers configured for your Checkly account.
canonical: 'https://www.checklyhq.com/docs/api-reference/deployment-triggers/list-all-deployment-triggers/'
---
12 changes: 6 additions & 6 deletions api-reference/openapi.json

Large diffs are not rendered by default.

7 changes: 7 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1031,6 +1031,13 @@
"api-reference/test-session-error-groups/retrieve-a-test-session-error-group",
"api-reference/test-session-error-groups/update-a-test-session-error-group"
]
},
{
"group": "Deployment Triggers",
"pages": [
"api-reference/deployment-triggers/list-all-deployment-triggers",
"api-reference/deployment-triggers/create-a-deployment-trigger"
]
}
]
}
Expand Down
17 changes: 17 additions & 0 deletions integrations/ci-cd/github/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,23 @@ After you link the repository, Checkly listens for successful deployment events
You can link multiple checks to the same repository. Checkly runs the linked checks as a test suite when GitHub reports a successful deployment.
</Note>

## Manage deployment hooks with the API

Use the Checkly Public API to create GitHub deployment hooks programmatically. A deployment trigger represents the link between one GitHub repository and either a check or a check group.

- [Create a deployment trigger](/api-reference/deployment-triggers/create-a-deployment-trigger) for a check or check group. Repeating the request for the same target returns the existing trigger without changing its settings.
- [List deployment triggers](/api-reference/deployment-triggers/list-all-deployment-triggers) for your account.

The API supports GitHub deployment triggers. To configure the Checkly Vercel integration, use the [Vercel integration settings](/integrations/ci-cd/vercel/overview).

<Warning>
If you omit both deployment filters, every successful deployment reported for the repository can trigger a run, including production deployments. Set `environmentRegexFilter` or `environmentUrlRegexFilter` when you only want to run checks against specific environments.
</Warning>

You can use deployment environment URLs with API, URL, browser, and multi-step checks. API and URL checks replace the host in the configured request URL. Browser and multi-step checks receive the deployment URL through the `ENVIRONMENT_URL` environment variable.

To change or remove a trigger created through the API, open the check or check group in Checkly and use its **CI/CD** settings.

## Use deployment environment URLs

GitHub reports an **environment URL** on each deployment event. Depending on what deployment service you use,
Expand Down
6 changes: 6 additions & 0 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,12 @@
<url>
<loc>https://www.checklyhq.com/docs/api-reference/dashboards/update-a-dashboard/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/deployment-triggers/create-a-deployment-trigger/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/deployment-triggers/list-all-deployment-triggers/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/api-reference/environment-variables/create-an-environment-variable/</loc>
</url>
Expand Down
Loading