Webhooks payload

The request body has the same standard JSON format for all Trados Cloud Platform events.

An example of request for a PROJECT_CREATED event:

{
  "eventId": "EVENT_ID",
  "eventType": "PROJECT.CREATED",
  "version": "1.0",
  "timestamp": "TIMESTAMP",
  "accountId": "ACCOUNT_ID",
  "data": {
    "id": "DATA_ID",
    "name": "PROJECT_NAME",
    "description": "PROJECT_DESCRIPTION",
    "customFields": [
      {
        "id": "CUSTOM_FIELD_ID1",
        "key": "CUSTOM_FIELD_KEY1",
        "value": "CUSTOM_FIELD_VALUE1"
      },
      {
        "id": "CUSTOM_FIELD_ID2",
        "key": "CUSTOM_FIELD_KEY2",
        "value": "CUSTOM_FIELD_VALUE2"
      }
    ]
  }
}

Note

Depending on the event type, the data field will contain a different object, representing the Data Payload Object as mentioned in the next example. This will include different details relevant to that event type, please check the table below.

This is the envelope that is common to all events, and only the < Data Payload Object part > is specific and depending on the event type.

{
  "eventId": "EVENT_ID",
  "eventType": "PROJECT.CREATED",
  "version": "1.0",
  "timestamp": "TIMESTAMP",
  "accountId": "ACCOUNT_ID",
  "data": {
    < Data Payload Object part >
  }
}

Event	Data payload object model	Trigger operations in Trados Cloud Platform API	Trigger operations in Trados UI
`PROJECT.TASK.ACCEPTED`	`task-event`	Accept task Accept error task	Accept task Accept error task
`PROJECT.TASK.CREATED`	`task-event`	Generate task	Generate task
`PROJECT.TASK.COMPLETED`	`task-event`	Complete task	Complete task
`PROJECT.TASK.UPDATED`	`task-event`	Generate task Accept task Reject task Release task Assign task Reassign task Complete task	Generate task Accept task Reject task Release task Assign task Reassign task Complete task
`PROJECT.TASK.DELETED`	`task-event`	Delete project and its tasks	Delete project and its tasks
`PROJECT.CREATED`	`project-event`	Create project	Create project
`PROJECT.STARTED`	`project-event`	Start project	Start project
`PROJECT.UPDATED`	`project-event`	Start project (This event will also be emitted in addition to `PROJECT.STARTED`) Update project by changing any field Complete project Cancel source file Complete target file	Start project (This event will also be emitted in addition to `PROJECT.STARTED`) Update project by changing the `Project Information`, `Configuration` or `Custom Fields` fields in the `Settings` tab Complete project Set project back in progress Cancel project Complete target file
`PROJECT.DELETED`	`project-event`	Delete project	Delete project
`PROJECT.TEMPLATE.CREATED`	`project-template-event`		Create project template
`PROJECT.TEMPLATE.UPDATED`	`project-template-event`		Create project template Update project template
`PROJECT.TEMPLATE.DELETED`	`project-template-event`		Delete project template
`PROJECT.SOURCE.FILE.CREATED`	`source-file-event`	Add source file to project Attach source files to project	Add reference file to project Add translatable file to project
`PROJECT.SOURCE.FILE.UPDATED`	`source-file-event`	Update source file by changing the `name` field Add source file version The project reaches the `File Type Detection` task The project reaches the `File Format Conversion` task	Update source file by changing the `fileType` or `fileRole` fields Add source file version via `Replace file` action Delete source file version Cancel source file The project reaches the `File Type Detection` task The project reaches the `File Format Conversion` task
`PROJECT.SOURCE.FILE.DELETED`	`source-file-event`	Delete project and its tasks	Delete project and its tasks
`PROJECT.TARGET.FILE.CREATED`	`target-file-event`	The project reaches the `File Format Conversion` task	The project reaches the `File Format Conversion` task
`PROJECT.TARGET.FILE.UPDATED`	`target-file-event`	Update source file by changing the `name` field Add target file version Import target file version The project reaches the `File Format Conversion` task The project reaches the `Copy Source to Target` task The project reaches the `Machine Translation` task The project reaches the `Bilingual Engineering` task The project reaches the `Translation` task The project reaches the `Linguistic Review` task The project reaches the `Customer Review` task The project reaches the `Implement Customer Review` task The project reaches the `Target File Generation` task	Add target file version via `Upload SDLXLIFF` action Replace target file Delete target file version Cancel target file The project reaches the `File Format Conversion` task The project reaches the `Copy Source to Target` task The project reaches the `Machine Translation` task The project reaches the `Bilingual Engineering` task The project reaches the `Translation` task The project reaches the `Linguistic Review` task The project reaches the `Customer Review` task The project reaches the `Implement Customer Review` task The project reaches the `Target File Generation` task
`PROJECT.TARGET.FILE.DELETED`	`target-file-event`	Delete project and its tasks	Delete project and its tasks
`PROJECT.GROUP.PROJECT.MEMBERSHIP.CHANGE`	`project-group-event`	Add project to project group Remove project from project group	Add project to project group Remove project from project group
`PROJECT.ERROR.TASK.CREATED`	`error-task-event`	Generate error task	Generate error task
`PROJECT.ERROR.TASK.COMPLETED`	`error-task-event`	Complete error task	Complete error task
`PROJECT.ERROR.TASK.ACCEPTED`	`error-task-event`	Accept error task	Accept error task