Skip to main content
POST
Create the trigger of a revision

Authorizations

Authorization
string
header
required

A Phrase Platform JWT issued for Orchestrator, sent as Authorization: Bearer <JWT>. See Authentication and access for how to obtain one.

Path Parameters

workflow_id
integer
required

ID of the workflow the revision belongs to.

Example:

123

revision_id
integer
required

ID of the revision the trigger belongs to.

Example:

789

Body

application/json

Trigger to create

Request body for creating a revision's trigger. Only source is required; omitted attributes fall back to the event's defaults. Filters reference the trigger by its id, so set them with PATCH once the trigger exists.

source
RevisionTriggerSource · object
required

The catalog event a revision trigger is bound to, as listed by GET /events.

Example:
input_parameters
object

Input parameters for the trigger, following the bound event's input_json_schema.

name
string

Name of the trigger. Defaults to the event's name.

Example:

"On project created"

Response

Created

The trigger configured on a revision, including its full configuration.

id
string<uuid>
required

Unique identifier of the trigger.

Example:

"5b0f7c3e-6d0a-4c5e-9a57-2f1f0c1e8d4a"

name
string
required

Name of the trigger.

Example:

"On project created"

source
RevisionTriggerSource · object
required

The catalog event a revision trigger is bound to, as listed by GET /events.

Example:
filters
TriggerFilters · object

Filters applied to incoming trigger data.

input_parameters
object

Input parameters for the trigger, following the bound event's input_json_schema.

webhook_url
string<uri> | null

URL to POST events to in order to start the workflow; null unless the source is a webhook event. New revisions keep the same URL.

Example:

"https://eu.phrase.com/orchestrator/webhooks/0b7e7c1c-3f4a-4d0e-9b8f-5a2d6c9e1f30"