Skip to main content
POST
Create an inbound URL (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/createIngressTrigger creates a capability URL that starts the workflow on each POST, and returns its token once.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:manage (an elevated permission) held at the workflow’s home and at the new trigger’s orgUnitId, as the Console decides it, on a workflow the caller may read (workflows:read at its home); 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 workflow that is missing, trashed or unreadable answers 404. 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

{workflowId, orgUnitId, versionId?, inputMode, wrapKey?, verification?, dedupeHeader?, ratePerMinute?, customerAttribution?}. inputMode schema takes the request body as the run’s inputs; wrap takes it as one input named wrapKey. verification is {mode: "none"} or {mode: "hmac_sha256", header, secret, scheme?}: the secret (at least 16 characters) is stored encrypted and never returned. A version that grants company access requires signing (422 otherwise). dedupeHeader names a sender header whose repeats are dropped; ratePerMinute caps accepted requests. customerAttribution ({source: "freshservice_company", inputField: "companyName"}) needs customers:manage and is refused to an External App (403).

The token is returned once

The response carries token and ingressUrl (which embeds the token) this once. They are never stored, logged or returned again, and a same-key retry answers 409 idempotency_result_unavailable without minting another token (see Routes that return a one-time secret). Store the token at once; a lost token is replaced only by rotating. Senders POST to ingressUrl; see Inbound URLs.

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.

Who a trigger belongs to

A Personal key’s trigger belongs to its owner’s worker seat and keeps firing after the key expires; a key whose owner has no active seat answers 422. An External App’s or platform key’s trigger belongs to the app or key, and stops (paused, audited) when the app or key loses workflows:manage. Editing a trigger never changes who it belongs to.

Responses

data is {trigger, ingress, token, tokenPrefix, ingressUrl, warning}. ingress is the configuration described in updateIngressConfig; warning repeats that the token will not be shown again.

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

workflowId
string
required

The workflow the URL starts.

Minimum string length: 1

Body

application/json
orgUnitId
string
required

The org unit its runs run at; you need workflows:manage there.

Minimum string length: 1
inputMode
enum<string>
required

schema: the body is the run's inputs; wrap: the body is one input.

Available options:
schema,
wrap
versionId
string
Minimum string length: 1
wrapKey
string
Minimum string length: 1
verification
object

How a sender proves itself; none accepts any holder of the URL.

dedupeHeader
string
Minimum string length: 1
ratePerMinute
integer
customerAttribution
object

Response

Created

data
object
required
meta
object
required