Create a recurring coding-agent trigger

Creates (or idempotently updates) a coding-agent trigger connector — the recurring, unattended run that burns down the ops queue in --pr mode. Discriminated…

Creates (or idempotently updates) a coding-agent trigger connector — the recurring, unattended run that burns down the ops queue in --pr mode. Discriminated on provider; only the four Shipeasy-fireable providers are accepted (claude_trigger, cursor_trigger, copilot_trigger, jules_trigger). Config + credential(s) arrive together; creates are idempotent by the provider's natural key, so re-creating updates the existing row.

Platforms without a fire endpoint (Codex, Windsurf, Cline, OpenClaw, OpenCode, Continue) cannot be created here — they are scheduled on their own platform (typically a GitHub Actions schedule: cron running the platform's headless CLI with the trigger prompt).

Use cases

Register a Claude routine — after RemoteTrigger {action:"create"} returns trig_…, { "provider": "claude_trigger", "config": { "routineId": "trig_…" } } (tokenless is fine; add the fire token later).
Cold Cursor/Jules run — repo coordinates + both keys; Shipeasy launches the run and the PR opens via the provider's GitHub App.
Copilot cloud agent — repo + a Copilot-licensed user PAT with the "Agent tasks" permission.

Authorization

bearerSdkKey

AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

Discriminator. Claude Code scheduled-routine trigger.

Value in"claude_trigger"

name?string

Human-readable connector label.

Default"Claude trigger"

Length1 <= length <= 80

events?array<>

Events that auto-fire the routine. Defaults to empty so the trigger does not auto-fire paid runs until events are subscribed.

Default[]

config*

Non-secret config for a Claude trigger.

token?string

The routine's fire bearer token (secret). Optional — a tokenless trigger is recorded but not fireable until a token is added later. Encrypted into the credentials cipher; never persisted in config or returned.

Length1 <= length

enabled?boolean

Whether the trigger is active on create.

Defaulttrue

provider*string

Discriminator. Cursor cloud-agent trigger.

Value in"cursor_trigger"

name?string

Human-readable connector label.

Default"Cursor trigger"

Length1 <= length <= 80

events?array<>

Events that auto-fire a cold cloud-agent run. Defaults to empty.

Default[]

config*

Non-secret config for a Cursor trigger.

apiKey*string

Cursor API key that launches the run (secret). Encrypted into the credentials cipher; never returned.

Length1 <= length

opsKey*string

Restricted Shipeasy ops key, injected into the run as SHIPEASY_CLI_TOKEN via the launch envVars (secret). Encrypted; never returned.

Length1 <= length

enabled?boolean

Whether the trigger is active on create.

Defaulttrue

provider*string

Discriminator. GitHub Copilot coding-agent trigger.

Value in"copilot_trigger"

name?string

Human-readable connector label.

Default"Copilot trigger"

Length1 <= length <= 80

events?array<>

Events that auto-fire a Copilot agent task. Defaults to empty.

Default[]

config*

Non-secret config for a Copilot trigger.

token*string

Copilot-licensed user PAT (secret). The ops key lives in the repo's GitHub "Agents" secret store and is never sent through Shipeasy. Encrypted; never returned.

Length1 <= length

enabled?boolean

Whether the trigger is active on create.

Defaulttrue

provider*string

Discriminator. Google Jules trigger.

Value in"jules_trigger"

name?string

Human-readable connector label.

Default"Jules trigger"

Length1 <= length <= 80

events?array<>

Events that auto-fire a Jules session. Defaults to empty.

Default[]

config*

Non-secret config for a Jules trigger.

apiKey*string

Jules API key that launches the session (secret). Encrypted into the credentials cipher; never returned.

Length1 <= length

opsKey*string

Restricted Shipeasy ops key, embedded in the prompt (Jules exposes no env channel) (secret). Encrypted; never returned.

Length1 <= length

enabled?boolean

Whether the trigger is active on create.

Defaulttrue

Response Body

`application/json`

curl -X POST "https://shipeasy.ai/api/admin/connectors/trigger" \  -H "Content-Type: application/json" \  -d '{    "provider": "claude_trigger",    "name": "Nightly ops sweep",    "config": {      "routineId": "trig_8fk20"    }  }'

{
  "id": "9b0e7c2a-1f3d-4a8e-bf21-0c6a2e5d7f10"
}

{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}

{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?

✎ Edit this page

Create a recurring coding-agent trigger

Authorization

Header Parameters

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

422application/json

Not an admin of this project

Feature gated behind a higher plan

Schema validation failed

Referenced entity missing

Group weights must sum to 10000

Event still pending review

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`