Skip to main content
POST
curl

Authorizations

Authorization
string
header
required

Organisation API key. Scoped operations carry x-triggr-scope; the scopes themselves are described in x-triggr-scopes.

Headers

Idempotency-Key
string

OPTIONAL — omit it and this operation behaves exactly as it always has. A unique value (a UUID) you choose per request. A retry with the same key and the same method, path and body within 24 hours gets the first response replayed (status and body, with Idempotent-Replayed: true) instead of running again; the same key with a different request is refused with 422. A 5xx is not stored, so that retry runs. A one-time credential is never stored: on a replay any secret is null, with an idempotentReplayNote explaining it.

Required string length: 1 - 255

Path Parameters

slug
string
required

Body

application/json
clientId
string
required
submission
object
required

fieldId → value

submitter
object
required

The person acting in your portal; at least one of name/email

display
object

fieldId → human label for id/code-valued answers

Response

OK

executionId
string
required
status
enum<string>
required
Available options:
running,
awaiting_approval
idempotentReplayNote
string

Present only on an Idempotency-Key replay whose original response carried a one-time credential: says that the value is shown only in the original response and how to issue a fresh one

secret
object | null

The one-time credential, shown ONCE. null on an Idempotency-Key replay — see idempotentReplayNote