Reference
Deployments
Deploy Hooks

Deploy Hooks API

Flightcontrol allows you to trigger deployments for any environment in your project using the Deploy Hooks API.

Using an HTTPS GET request, you can start a deployment. The response returns the deployment's unique ID.

You can poll the deployment's status with the Get Deployment API.

Configuration

  1. Go to the environment settings page by clicking Edit Environment Edit Environment button in dashboard
  2. Locate the Deploy Hooks form, enter a name to remember it by, then click Create Deploy Hook Create Deploy Hook form in dashboard

To trigger a deployment with this hook, make an HTTPS GET request to the generated url

MethodPathPayload
GET/api/deploy-hook/[envId]/[securerandomstring]None

Response Example

{
  "success": "true",
  "deploymentId": "clcpcxekt000lc9ojqtgtc26y"
}

Response Conditions

Success

Errors