Skip to main content
POST
Pause or resume an ingress trigger
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

POST /api/v2/workflows/setIngressStatus pauses or resumes an ingress trigger’s URL. A paused URL answers 410 to senders.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:manage (an elevated permission) held at the trigger’s orgUnitId and at the platform scope, as the Console decides it; otherwise 403, recorded, and nothing is written. Forge agents can never hold workflows:manage. Because the success returns what was written, the credential’s scopes must include workflows:read as well; otherwise 403 naming workflows:read. A trigger the caller may not read (workflows:read at its workflow’s home and at its orgUnitId) answers 404, as a missing one does. A Personal key acts as its owner; an External App or platform key acts as itself. The change is audited with that actor and, for an app or platform key, who granted it.

Body

{id, status}, where status is active or paused. Resuming re-runs the version entitlement and signing decisions.

Version entitlement

A trigger runs a published version, so the version’s agents and bound companies are decided for the caller as at a publish: agents:use and credentials:use, each reached by its own scope. A refusal is 422 naming the gate’s code, and nothing is written.

Idempotency

Send an Idempotency-Key to make a retry safe: a same-key retry within 24 hours returns the recorded result only while the caller may still read the trigger and holds workflows:manage at its org unit and the platform scope; otherwise 409 idempotency_result_unavailable, and the write never runs twice (see Idempotency).

Responses

data is {trigger, ingress}. trigger has the fields described in getTrigger; ingress is null for a cron or one-shot trigger, and otherwise the ingress configuration: status, tokenPrefix (for display only), inputMode, wrapKey, dedupeHeader, ratePerMinute, verification (mode, header and scheme, never the secret) and customerAttributionConfigured. The owner, creator, stored inputs, token and token hash are never returned.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without writing again.

Required string length: 1 - 255

Path Parameters

triggerId
string
required

The ingress trigger.

Minimum string length: 1

Body

application/json
status
enum<string>
required
Available options:
active,
paused

Response

Success

data
object
required
meta
object
required