Skip to main content
GET
Get a single event

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

id
integer
required

ID of the event.

Example:

42

Response

OK

Detailed information about a single event, including the JSON Schema of its payload.

description
string
required

When the event fires and what it represents.

Example:

"Fires when a translation job is completed in Phrase TMS."

id
integer
required

Unique identifier of the event.

Example:

42

name
string
required

Name of the event.

Example:

"Job completed"

operation_id
string
required

Operation identifier used with provider to reference this event.

Example:

"job.completed"

provider
enum<string>
required

Product that emits the event: strings (Phrase Strings), tms (Phrase TMS, the translation management system) or orchestrator (Orchestrator, including schedules and webhooks).

Available options:
strings,
tms,
orchestrator
Example:

"tms"

input_json_schema
object
required

JSON Schema for the configuration supplied when using this event as a workflow trigger, written to the trigger's input_parameters. An empty object means no configuration is required.

output_json_schema
object
required

JSON Schema describing the payload delivered when the event fires. Downstream actions reference these field paths via JSONPath interpolation, setting the parameter's type to trigger and its source to trigger in a workflow definition, for example {"value": "{{ $.job_id }}", "source": "trigger", "type": "trigger"}, or to the trigger's id on the per-task endpoints.