Create deploy trigger

Create or rotate a secret URL that can trigger deployments. The token is shown only once.

POST /api/services/{id}/deploy-trigger HTTPS

Request & response examples

Request example Server-side

curl --fail-with-body --request POST \
  'https://app.helicarrier.xyz/api/services/YOUR_ID/deploy-trigger' \
  -H "Authorization: Bearer $HELI_API_KEY"

const response = await fetch(
  "https://app.helicarrier.xyz/api/services/YOUR_ID/deploy-trigger",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.HELI_API_KEY}`
    }
  }
);
const data = await response.json();
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${data.error}`);
}
// Inspect data; avoid logging secret responses.

import os
import requests

response = requests.request(
    "POST",
    "https://app.helicarrier.xyz/api/services/YOUR_ID/deploy-trigger",
    headers={
        "Authorization": f"Bearer {os.environ['HELI_API_KEY']}"
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
# Inspect data; avoid logging secret responses.

Response example 201

{
  "configured": true,
  "token": "REDACTED",
  "url": "REDACTED_DEPLOY_TRIGGER_URL"
}

Illustrative values · selected fields

Response details ↓ OpenAPI ↗

Authorization

An account key with access, or a project/service key with deployments:write. The resource must be within the key’s project, service, and environment scope.

Authorization: Bearer <key> Key setup ↗

Path parameters

id string required

Service id.

Response 201

The newly issued trigger URL is returned once. It authorizes deployment without an API key; store it as a secret. Rotating invalidates the previous URL.

Examples show selected response fields with illustrative values. Your response can contain additional fields.

configured boolean

Whether a deploy trigger is enabled.

token string

Secret deploy-trigger token, returned once.

url string

Secret deploy-trigger URL, returned once.

Errors

401

The API key is missing, invalid, or revoked.

403

The caller or key scope does not permit this operation.

500

The operation could not be completed. Check resource state before retrying a write.

Error handling and safe retries

ALSO AVAILABLE VIA MCP

`create_deploy_trigger`

Required MCP arguments: id. Send path, query, and body fields together as tool arguments.

Connect your agent ↗

import os import requests response = requests.request( "POST", "https://app.helicarrier.xyz/api/services/YOUR_ID/deploy-trigger", headers={ "Authorization": f"Bearer {os.environ['HELI_API_KEY']}" }, timeout=30, ) response.raise_for_status() data = response.json() # Inspect data; avoid logging secret responses.