Skip to main content

Webhooks Events Catalog

This catalog documents all available Smartling webhook events. Webhooks allow your system or application to receive real-time notifications when specific events occur in your Smartling account. Click on an event description to view the payload structure for that event type.


Files

Webhook Event

Description

file.deleted

Invoked when a file is deleted.

{
  "eventId": "614fcbb6-95ba-4755-8b29-b1277ed38a75",
  "eventType": "file.deleted",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "8f14fdfdc",
    "accountName": "Test Account"
  },
  "project": {
    "projectUid": "8e531bb8d",
    "projectName": "Test Project",
    "projectTypeCode": "BUSINESS_DOCUMENTS",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "es-ES",
        "description": "Spanish (Spain) [es-ES]"
      }
    ]
  },
  "file": {
    "fileUid": "05d9dsds4ef97",
    "fileUri": "test.properties",
    "fileType": "JAVA_PROPERTIES",
    "createdDate": "2026-01-26T13:58:07Z",
    "lastUploadedDate": "2026-01-26T13:58:07Z",
    "namespace": "test.properties",
    "callbackUrl": null,
    "directives": {
      "file_uri_as_namespace": "true"
    },
    "deletedDate": "2026-01-26T13:58:21Z",
    "deletedByUser": {
      "userUid": "1764dsdsfa590",
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

file.prepublished

Invoked when all authorized content in a file is prepublished for a locale.

{
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "file.prepublished",
  "schemaVersion": "1.0",
  "file": {
    "callbackUrl": "http://my.company.com/callback",
    "createdDate": "2017-09-06T20:29:15Z",
    "directives": {
      "file_uri_as_namespace": "true"
    },
    "fileType": "ANDROID",
    "fileUid": "file123456",
    "fileUri": "/res/values/strings.xml",
    "lastUploadedDate": "2017-09-06T20:29:15Z",
    "namespace": "/files/test_trans_import.csv",
    "prepublishDate": "2017-09-06T20:29:15Z",
    "prepublishedLocale": {
      "localeId": "fr-FR",
      "description": "French (France) [fr-FR]"
    }
  },
  "project": {
    "projectUid": "proj123456",
    "projectName": "Test Project",
    "projectTypeCode": "SHOPIFY",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-CA",
        "description": "French (Canada) [fr-CA]"
      },
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      }
    ]
  },
  "account": {
    "accountUid": "acc123456",
    "accountName": "Sandbox"
  }
}

file.published

Invoked when all authorized content in a file reaches the published workflow step for a locale.

{
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "file.published",
  "schemaVersion": "1.0",
  "file": {
    "callbackUrl": "http://my.company.com/callback",
    "createdDate": "2017-09-06T20:29:15Z",
    "directives": {
      "file_uri_as_namespace": "true"
    },
    "fileType": "ANDROID",
    "fileUid": "file123456",
    "fileUri": "/res/values/strings.xml",
    "lastUploadedDate": "2017-09-06T20:29:15Z",
    "namespace": "/files/test_trans_import.csv",
    "publishDate": "2017-09-06T20:29:15Z",
    "publishedLocale": {
      "localeId": "fr-FR",
      "description": "French (France) [fr-FR]"
    }
  },
  "project": {
    "projectUid": "proj123456",
    "projectName": "Test Project",
    "projectTypeCode": "SHOPIFY",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-CA",
        "description": "French (Canada) [fr-CA]"
      },
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      }
    ]
  },
  "account": {
    "accountUid": "acc123456",
    "accountName": "Sandbox"
  }
}

file.renamed

Invoked when a file is renamed.

{
  "eventId": "bd11010b-410d-4834-939b-d5aa38310c33",
  "eventType": "file.renamed",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "8f14e45fc",
    "accountName": "Test Account"
  },
  "project": {
    "projectUid": "8e531bb8d",
    "projectName": "Test Project",
    "projectTypeCode": "BUSINESS_DOCUMENTS",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "es-ES",
        "description": "Spanish (Spain) [es-ES]"
      }
    ]
  },
  "file": {
    "fileUid": "a2a399dad71d",
    "fileUri": "test_1.properties",
    "fileType": "JAVA_PROPERTIES",
    "createdDate": "2026-01-26T13:30:12Z",
    "lastUploadedDate": "2026-01-26T13:30:12Z",
    "namespace": "test_1.properties",
    "callbackUrl": null,
    "directives": {
      "file_uri_as_namespace": "true"
    },
    "previousFileUri": "test_2.properties",
    "renamedDate": "2026-01-26T13:44:11Z",
    "previousNamespace": "test_2.properties",
    "renamedByUser": {
      "userUid": "176fddffa590",
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

file.uploaded

Invoked when a file is uploaded.

{
  "eventId": "8f6e236d-5dd0-46e0-b628-31fdc83a620b",
  "eventType": "file.uploaded",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "8f1ds45fc",
    "accountName": "Test Account"
  },
  "project": {
    "projectUid": "8e5sdb8d",
    "projectName": "Test Project",
    "projectTypeCode": "BUSINESS_DOCUMENTS",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "es-ES",
        "description": "Spanish (Spain) [es-ES]"
      }
    ]
  },
  "file": {
    "fileUid": "05d90d54ef97",
    "fileUri": "test.properties",
    "fileType": "JAVA_PROPERTIES",
    "createdDate": "2026-01-26T13:58:07Z",
    "lastUploadedDate": "2026-01-26T13:58:07Z",
    "namespace": "test.properties",
    "callbackUrl": null,
    "directives": {
      "file_uri_as_namespace": "true"
    },
    "summary": {
      "stringsCount": 3,
      "wordsCount": 3,
      "pageCount": null
    },
    "uploadedByUser": {
      "userUid": "1764424fa590",
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

Integrations

Webhook Event

Description

integrations.platform.asset.exported

Invoked when a connector asset has been exported, meaning an asset's translations have been delivered back to the connected platform through one of Smartling's pre-built connectors.

{
  "eventId": "39cec1eb-a721-46e3-9db7-3972bef38dd1",
  "eventType": "integrations.platform.asset.exported",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "2f23eaae9",
    "accountName": "Sandbox"
  },
  "project": {
    "projectUid": "21512a5b8",
    "projectName": "Shopify Connector - Test",
    "projectTypeCode": "SHOPIFY",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-CA",
        "description": "French (Canada) [fr-CA]"
      },
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "de-DE",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "es-ES",
        "description": "Spanish (Spain) [es-ES]"
      },
      {
        "localeId": "es-US",
        "description": "Spanish (United States) [es-US]"
      }
    ]
  },
  "asset": {
    "integrationId": "shopify",
    "fileUri": "The Complete Snowboard-PRODUCT-9044325794073.json",
    "assetUid": "PRODUCT-9044325794073",
    "externalAssetId": null,
    "targetLocales": [
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      }
    ]
  }
}

Issues

Webhook Event

Description

sourceIssue.created

Invoked when a source issue is created.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "sourceIssue.created",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "sourceIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2025-08-20T12:40:00Z",
        "text": "Comment text."
      }
    ],
    "createdDate": "2025-08-20T12:34:56Z",
    "hashcode": "b6f0f1c9e1a04a11",
    "reactivated": false,
    "reopenedDate": null,
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": null,
    "sourceIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        },
        {
          "userUid": "usr123456"
        }
      ]
    },
    "sourceIssueNumber": 1,
    "sourceIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "sourceIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "sourceIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "sourceIssueText": "Source Issue Text",
    "sourceIssueUid": "proj123456"
  }
}

sourceIssue.deleted

Invoked when a source issue is deleted.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "sourceIssue.deleted",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "sourceIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2025-08-20T12:40:00Z",
        "text": "Comment text."
      }
    ],
    "createdDate": "2025-08-20T12:34:56Z",
    "hashcode": "b6f0f1c9e1a04a11",
    "reactivated": false,
    "reopenedDate": null,
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": null,
    "sourceIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        },
        {
          "userUid": "usr123456"
        }
      ]
    },
    "sourceIssueNumber": 1,
    "sourceIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "sourceIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "sourceIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "sourceIssueText": "Source Issue Text",
    "sourceIssueUid": "proj123456"
  }
}

sourceIssue.updated

Invoked when a source issue is updated.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "sourceIssue.updated",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "sourceIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2025-08-20T12:40:00Z",
        "text": "Comment text."
      }
    ],
    "createdDate": "2025-08-20T12:34:56Z",
    "hashcode": "b6f0f1c9e1a04a11",
    "reactivated": false,
    "reopenedDate": null,
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": null,
    "sourceIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        },
        {
          "userUid": "usr123456"
        }
      ]
    },
    "sourceIssueNumber": 1,
    "sourceIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "sourceIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "sourceIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "sourceIssueText": "Source Issue Text",
    "sourceIssueUid": "proj123456"
  }
}

sourceIssue.comment.created

Invoked when a comment is added to a source issue.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "sourceIssue.comment.created",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "sourceIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": null
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "text1",
        "updatedDate": "2017-09-06T20:29:15Z"
      },
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "text": "text2",
        "updatedDate": "2017-09-06T20:29:15Z"
      }
    ],
    "createdDate": "2017-09-06T20:29:15Z",
    "hashcode": "hash1234567890",
    "reactivated": false,
    "reopenedDate": "2017-09-06T20:29:15Z",
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": "2017-09-06T20:29:15Z",
    "sourceIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "sourceIssueNumber": 63082,
    "sourceIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "sourceIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "sourceIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "sourceIssueText": "Issue text",
    "sourceIssueUid": "proj123456"
  },
  "sourceIssueComment": {
    "commentUid": "com123456",
    "createdByUser": {
      "userUid": "usr123456"
    },
    "createdDate": "2017-09-06T20:29:15Z",
    "text": "text2",
    "updatedDate": "2017-09-06T20:29:15Z"
  }
}

sourceIssue.comment.deleted

Invoked when a source issue comment is deleted.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "sourceIssue.comment.deleted",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "sourceIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": null
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "text1",
        "updatedDate": "2017-09-06T20:29:15Z"
      },
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "text": "text2",
        "updatedDate": "2017-09-06T20:29:15Z"
      }
    ],
    "createdDate": "2017-09-06T20:29:15Z",
    "hashcode": "hash1234567890",
    "reactivated": false,
    "reopenedDate": "2017-09-06T20:29:15Z",
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": "2017-09-06T20:29:15Z",
    "sourceIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "sourceIssueNumber": 63082,
    "sourceIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "sourceIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "sourceIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "sourceIssueText": "Issue text",
    "sourceIssueUid": "proj123456"
  },
  "sourceIssueComment": {
    "commentUid": "com123456",
    "createdByUser": {
      "userUid": "usr123456"
    },
    "createdDate": "2017-09-06T20:29:15Z",
    "text": "text2",
    "updatedDate": "2017-09-06T20:29:15Z"
  }
}

sourceIssue.comment.updated

Invoked when a source issue comment is updated.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "sourceIssue.comment.updated",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "sourceIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": null
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "text1",
        "updatedDate": "2017-09-06T20:29:15Z"
      },
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "text": "text2",
        "updatedDate": "2017-09-06T20:29:15Z"
      }
    ],
    "createdDate": "2017-09-06T20:29:15Z",
    "hashcode": "hash1234567890",
    "reactivated": false,
    "reopenedDate": "2017-09-06T20:29:15Z",
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": "2017-09-06T20:29:15Z",
    "sourceIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "sourceIssueNumber": 63082,
    "sourceIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "sourceIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "sourceIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "sourceIssueText": "Issue text",
    "sourceIssueUid": "proj123456"
  },
  "sourceIssueComment": {
    "commentUid": "com123456",
    "createdByUser": {
      "userUid": "usr123456"
    },
    "createdDate": "2017-09-06T20:29:15Z",
    "text": "text2",
    "updatedDate": "2017-09-06T20:29:15Z"
  }
}

translationIssue.created

Invoked when a translation issue is created.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "translationIssue.created",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "translationIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2025-08-20T12:40:00Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "Comment text example.",
        "updatedDate": "2025-08-20T12:40:00Z"
      }
    ],
    "createdDate": "2025-08-20T12:34:56Z",
    "hashcode": "hashcode-example-1234567890",
    "locale": {
      "localeId": "fr-FR"
    },
    "reactivated": false,
    "reopenedDate": null,
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": null,
    "translationIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "translationIssueNumber": 8921,
    "translationIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "translationIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "translationIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "translationIssueText": "Translation issue text example.",
    "translationIssueUid": "proj123456"
  }
}

translationIssue.deleted

Invoked when a translation issue is deleted.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "translationIssue.deleted",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "translationIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2025-08-20T12:40:00Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "Comment text example.",
        "updatedDate": "2025-08-20T12:40:00Z"
      }
    ],
    "createdDate": "2025-08-20T12:34:56Z",
    "hashcode": "hashcode-example-1234567890",
    "locale": {
      "localeId": "fr-FR"
    },
    "reactivated": false,
    "reopenedDate": null,
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": null,
    "translationIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "translationIssueNumber": 8921,
    "translationIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "translationIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "translationIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "translationIssueText": "Translation issue text example.",
    "translationIssueUid": "proj123456"
  }
}

translationIssue.updated

Invoked when a translation issue is updated.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "translationIssue.updated",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "translationIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": "usr123456"
        },
        "createdDate": "2025-08-20T12:40:00Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "Comment text example.",
        "updatedDate": "2025-08-20T12:40:00Z"
      }
    ],
    "createdDate": "2025-08-20T12:34:56Z",
    "hashcode": "hashcode-example-1234567890",
    "locale": {
      "localeId": "fr-FR"
    },
    "reactivated": false,
    "reopenedDate": null,
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": null,
    "translationIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "translationIssueNumber": 8921,
    "translationIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "translationIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "translationIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "translationIssueText": "Translation issue text example.",
    "translationIssueUid": "proj123456"
  }
}

translationIssue.comment.created

Invoked when a comment is added to a translation issue.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "translationIssue.comment.created",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "translationIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": null
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "comment text",
        "updatedDate": "2017-09-06T20:29:15Z"
      }
    ],
    "createdDate": "2017-09-06T20:29:15Z",
    "hashcode": "ceba97435019e0b6329599d8bca20d91",
    "locale": {
      "localeId": "fr-FR"
    },
    "reactivated": false,
    "reopenedDate": "2017-09-06T20:29:15Z",
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": "2017-09-06T20:29:15Z",
    "translationIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "translationIssueNumber": 63082,
    "translationIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "translationIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "translationIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "translationIssueText": "Issue text",
    "translationIssueUid": "proj123456"
  },
  "translationIssueComment": {
    "commentUid": "com123456",
    "createdByUser": {
      "userUid": "usr123456"
    },
    "createdDate": "2017-09-06T20:29:15Z",
    "mentions": {
      "users": []
    },
    "text": "text2",
    "updatedDate": "2017-09-06T20:29:15Z"
  }
}

translationIssue.comment.deleted

Invoked when a translation issue comment is deleted.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "translationIssue.comment.deleted",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "translationIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": null
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "comment text",
        "updatedDate": "2017-09-06T20:29:15Z"
      }
    ],
    "createdDate": "2017-09-06T20:29:15Z",
    "hashcode": "ceba97435019e0b6329599d8bca20d91",
    "locale": {
      "localeId": "fr-FR"
    },
    "reactivated": false,
    "reopenedDate": "2017-09-06T20:29:15Z",
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": "2017-09-06T20:29:15Z",
    "translationIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "translationIssueNumber": 63082,
    "translationIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "translationIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "translationIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "translationIssueText": "Issue text",
    "translationIssueUid": "proj123456"
  },
  "translationIssueComment": {
    "commentUid": "com123456",
    "createdByUser": {
      "userUid": "usr123456"
    },
    "createdDate": "2017-09-06T20:29:15Z",
    "mentions": {
      "users": []
    },
    "text": "text2",
    "updatedDate": "2017-09-06T20:29:15Z"
  }
}

translationIssue.comment.updated

Invoked when a translation issue comment is updated.

{
  "account": {
    "accountUid": "acc123456"
  },
  "eventId": "7a3e610b-840e-416d-a5d7-bb7eca3ef5bf",
  "eventType": "translationIssue.comment.updated",
  "project": {
    "projectUid": "proj123456"
  },
  "schemaVersion": "1.0",
  "translationIssue": {
    "answered": false,
    "assigneeUser": {
      "userUid": "usr123456"
    },
    "comments": [
      {
        "commentUid": "com123456",
        "createdByUser": {
          "userUid": null
        },
        "createdDate": "2017-09-06T20:29:15Z",
        "mentions": {
          "users": [
            {
              "userUid": "usr123456"
            }
          ]
        },
        "text": "comment text",
        "updatedDate": "2017-09-06T20:29:15Z"
      }
    ],
    "createdDate": "2017-09-06T20:29:15Z",
    "hashcode": "ceba97435019e0b6329599d8bca20d91",
    "locale": {
      "localeId": "fr-FR"
    },
    "reactivated": false,
    "reopenedDate": "2017-09-06T20:29:15Z",
    "reportedByUser": {
      "userUid": "usr123456"
    },
    "resolvedByUser": {
      "userUid": "usr123456"
    },
    "resolvedDate": "2017-09-06T20:29:15Z",
    "translationIssueMentions": {
      "users": [
        {
          "userUid": "usr123456"
        }
      ]
    },
    "translationIssueNumber": 63082,
    "translationIssueSeverityLevel": {
      "code": "MEDIUM",
      "description": "Medium"
    },
    "translationIssueState": {
      "code": "OPENED",
      "description": "Opened"
    },
    "translationIssueSubType": {
      "code": "CLARIFICATION",
      "description": "Clarification"
    },
    "translationIssueText": "Issue text",
    "translationIssueUid": "proj123456"
  },
  "translationIssueComment": {
    "commentUid": "com123456",
    "createdByUser": {
      "userUid": "usr123456"
    },
    "createdDate": "2017-09-06T20:29:15Z",
    "mentions": {
      "users": []
    },
    "text": "text2",
    "updatedDate": "2017-09-06T20:29:15Z"
  }
}

Jobs

Webhook Event

Description

translationJob.canceled

Invoked when a job is canceled.

{
  "eventId": "ef4a7117-e838-497a-8a10-68a158c94dcd",
  "eventType": "translationJob.canceled",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "18e49ce1",
    "accountName": "Webhook Test Account"
  },
  "project": {
    "projectUid": "d3e08fhc1",
    "projectName": "webhook-project",
    "projectTypeCode": "APPLICATION_RESOURCES",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "fr",
        "description": "French (International) [fr]"
      },
      {
        "localeId": "de-DE",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "ru-RU",
        "description": "Russian (Russia) [ru-RU]"
      },
      {
        "localeId": "es",
        "description": "Spanish (International) [es]"
      },
      {
        "localeId": "uk-UA",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ]
  },
  "translationJob": {
    "createdDate": "2025-12-09T13:38:31Z",
    "updatedDate": "2025-12-10T13:58:04Z",
    "rushRequest": null,
    "jobUid": "ndpz5zkzd4wh",
    "jobStatus": "CANCELED",
    "customFields": [],
    "createdByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "jobNumber": "ER-331",
    "jobName": "request-translation-webhook-test    (Cancelled 2025/12/10 13:58:04)",
    "jobDescription": "Test description 3",
    "jobDueDate": null,
    "referenceNumber": "updated-ref-number-12345",
    "updatedByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "authorizedByUser": null,
    "targetLocales": [],
    "files": []
  }
}

translationJob.completed

Invoked when all authorized content in a job, for all locales, reaches the published step of the workflow.

{
  "eventId": "f6e899fe-1b54-4ca2-a914-8dc43f6f4ec2",
  "eventType": "translationJob.completed",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "18e49ce1",
    "accountName": "Webhook Test Account"
  },
  "project": {
    "projectUid": "d3e08fhc1",
    "projectName": "webhook-project",
    "projectTypeCode": "APPLICATION_RESOURCES",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "fr",
        "description": "French (International) [fr]"
      },
      {
        "localeId": "de-DE",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "ru-RU",
        "description": "Russian (Russia) [ru-RU]"
      },
      {
        "localeId": "es",
        "description": "Spanish (International) [es]"
      },
      {
        "localeId": "uk-UA",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ]
  },
  "translationJob": {
    "createdDate": "2025-12-09T13:38:31Z",
    "updatedDate": "2025-12-10T13:48:52Z",
    "rushRequest": null,
    "jobUid": "ndpz5zkzd4wh",
    "jobStatus": "COMPLETED",
    "customFields": [
      {
        "customField": {
          "customFieldValue": "test department changed",
          "customFieldUid": "aus64ecmvvtm",
          "customFieldType": "SHORT_TEXT",
          "customFieldName": "Department name",
          "customFieldDescription": "Description Label"
        }
      },
      {
        "customField": {
          "customFieldValue": "true",
          "customFieldUid": "8uay2nrxqoci",
          "customFieldType": "CHECKBOX",
          "customFieldName": "Blocked",
          "customFieldDescription": "Description Label"
        }
      }
    ],
    "createdByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "jobNumber": "ER-331",
    "jobName": "request-translation-webhook-test",
    "jobDescription": "Test description 3",
    "jobDueDate": "2025-12-10T14:56:00Z",
    "referenceNumber": "updated-ref-number-12345",
    "updatedByUser": {
      "userUid": null
    },
    "authorizedByUser": null,
    "targetLocales": [
      {
        "localeId": "es",
        "status": "COMPLETED",
        "description": "Spanish (International) [es]"
      }
    ],
    "files": [
      {
        "fileUri": "strings-34.properties",
        "fileUid": "4673cb60768c",
        "localeIds": [
          "es"
        ]
      },
      {
        "fileUri": "strings-33.properties",
        "fileUid": "c9b4b7c73a52",
        "localeIds": [
          "es"
        ]
      }
    ]
  }
}

translationJob.created

Invoked when a job is created.

{
  "eventId": "f21f5173-199d-4db2-8264-e36150a4f836",
  "eventType": "translationJob.created",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "18e49ce1",
    "accountName": "Webhook Test Account"
  },
  "project": {
    "projectUid": "d3e08fhc1",
    "projectName": "webhook-project",
    "projectTypeCode": "APPLICATION_RESOURCES",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "fr",
        "description": "French (International) [fr]"
      },
      {
        "localeId": "de-DE",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "ru-RU",
        "description": "Russian (Russia) [ru-RU]"
      },
      {
        "localeId": "es",
        "description": "Spanish (International) [es]"
      },
      {
        "localeId": "uk-UA",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ]
  },
  "translationJob": {
    "createdDate": "2025-12-09T13:38:31Z",
    "updatedDate": "2025-12-09T13:38:31Z",
    "rushRequest": false,
    "jobUid": "ndpz5zkzd4wh",
    "jobStatus": "AWAITING_AUTHORIZATION",
    "customFields": [
      {
        "customField": {
          "customFieldValue": "test department name",
          "customFieldUid": "aus64ecmvvtm",
          "customFieldType": "SHORT_TEXT",
          "customFieldName": "Department name",
          "customFieldDescription": "Description Label"
        }
      },
      {
        "customField": {
          "customFieldValue": "false",
          "customFieldUid": "8uay2nrxqoci",
          "customFieldType": "CHECKBOX",
          "customFieldName": "Blocked",
          "customFieldDescription": "Description Label"
        }
      }
    ],
    "createdByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "jobNumber": "ER-331",
    "jobName": "request-translation-webhook-test",
    "jobDescription": "Test description ",
    "jobDueDate": "2025-12-10T14:56:00Z",
    "referenceNumber": "code-1234",
    "updatedByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "authorizedByUser": null,
    "targetLocales": [
      {
        "localeId": "fr-FR",
        "status": "EMPTY",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "fr",
        "status": "EMPTY",
        "description": "French (International) [fr]"
      },
      {
        "localeId": "de-DE",
        "status": "EMPTY",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "es",
        "status": "EMPTY",
        "description": "Spanish (International) [es]"
      },
      {
        "localeId": "uk-UA",
        "status": "EMPTY",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ],
    "files": []
  }
}

translationJob.localeWorkflowStep.reached

Invoked each time all authorized content in a job, for a specific locale, reaches a step in the workflow.

{
  "eventId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "eventType": "translationJob.localeWorkflowStep.reached",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "8f14fdfdc",
    "accountName": "Test Account"
  },
  "project": {
    "projectUid": "8e531bb8d",
    "projectName": "Test Project",
    "projectTypeCode": "APPLICATION_RESOURCES",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "es-ES",
        "description": "Spanish (Spain) [es-ES]"
      },
      {
        "localeId": "uk-UA",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ]
  },
  "translationJob": {
    "jobUid": "3333cccc3333",
    "jobName": "Website Localization - January",
    "jobStatus": "IN_PROGRESS",
    "jobNumber": null,
    "jobDescription": null,
    "jobDueDate": null,
    "referenceNumber": null,
    "rushRequest": false,
    "createdDate": "2026-01-15T17:58:05.000Z",
    "updatedDate": "2026-01-15T17:59:28.000Z",
    "createdByUser": {
      "userUid": "1111aaaa1111"
    },
    "updatedByUser": {
      "userUid": "1111aaaa1111"
    },
    "authorizedByUser": null,
    "targetLocales": [
      {
        "localeId": "uk-UA",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ],
    "files": [
      {
        "fileUid": "2222bbbb2222",
        "fileUri": "homepage.properties",
        "localeIds": []
      }
    ],
    "customFields": []
  },
  "localeWorkflowStep": {
    "locale": {
      "localeId": "uk-UA",
      "description": "Ukrainian (Ukraine) [uk-UA]"
    },
    "reachedDate": "2026-01-15T18:00:01.416Z",
    "workflow": {
      "workflowUid": "aaaa1111bbbb",
      "workflowName": "Sample Workflow",
      "workflowSteps": [
        {
          "workflowStepUid": "1111aaaa1111",
          "workflowStepType": "TRANSLATION",
          "workflowStepName": "Amazon Translate"
        },
        {
          "workflowStepUid": "2222bbbb2222",
          "workflowStepType": "DECISION",
          "workflowStepName": "Decision step"
        },
        {
          "workflowStepUid": "3333cccc3333",
          "workflowStepType": "TRANSLATION",
          "workflowStepName": "DeepL"
        },
        {
          "workflowStepUid": "4444dddd4444",
          "workflowStepType": "POST_TRANSLATION",
          "workflowStepName": "Edit"
        },
        {
          "workflowStepUid": "5555eeee5555",
          "workflowStepType": "TRANSLATION",
          "workflowStepName": "Google Translate"
        },
        {
          "workflowStepUid": "6666ffff6666",
          "workflowStepType": "SYSTEM",
          "workflowStepName": "Processing"
        },
        {
          "workflowStepUid": "7777aaaa7777",
          "workflowStepType": "SYSTEM",
          "workflowStepName": "Processing Branch 1"
        },
        {
          "workflowStepUid": "8888bbbb8888",
          "workflowStepType": "SYSTEM",
          "workflowStepName": "Processing Branch 2"
        },
        {
          "workflowStepUid": "9999cccc9999",
          "workflowStepType": "PUBLISH",
          "workflowStepName": "Published"
        }
      ]
    },
    "workflowStep": {
      "workflowStepUid": "5555eeee5555",
      "workflowStepType": "TRANSLATION",
      "workflowStepName": "Google Translate"
    }
  }
}

translationJob.updated

Invoked when a job is updated (e.g., when the job name, due dates, attachments, or files are modified, added, or removed). This includes any job update, including when a job is authorized for translation and moves to In Progress status.

{
  "eventId": "bcb28ad4-1f08-44be-a02e-89bf5be12d2b",
  "eventType": "translationJob.updated",
  "schemaVersion": "1.0",
  "account": {
    "accountUid": "18e49ce1",
    "accountName": "Webhook Test Account"
  },
  "project": {
    "projectUid": "d3e08fhc1",
    "projectName": "webhook-project",
    "projectTypeCode": "APPLICATION_RESOURCES",
    "sourceLocale": {
      "localeId": "en-US",
      "description": "English (United States) [en-US]"
    },
    "targetLocales": [
      {
        "localeId": "fr-FR",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "fr",
        "description": "French (International) [fr]"
      },
      {
        "localeId": "de-DE",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "ru-RU",
        "description": "Russian (Russia) [ru-RU]"
      },
      {
        "localeId": "es",
        "description": "Spanish (International) [es]"
      },
      {
        "localeId": "uk-UA",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      }
    ]
  },
  "translationJob": {
    "createdDate": "2025-12-09T13:38:31Z",
    "updatedDate": "2025-12-09T13:56:32Z",
    "rushRequest": true,
    "jobUid": "ndpz5zkzd4wh",
    "jobStatus": "IN_PROGRESS",
    "customFields": [
      {
        "customField": {
          "customFieldValue": "test department changed",
          "customFieldUid": "aus64ecmvvtm",
          "customFieldType": "SHORT_TEXT",
          "customFieldName": "Department name",
          "customFieldDescription": "Description Label"
        }
      },
      {
        "customField": {
          "customFieldValue": "true",
          "customFieldUid": "8uay2nrxqoci",
          "customFieldType": "CHECKBOX",
          "customFieldName": "Blocked",
          "customFieldDescription": "Description Label"
        }
      }
    ],
    "createdByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "jobNumber": "ER-331",
    "jobName": "request-translation-webhook-test",
    "jobDescription": "Test description 2",
    "jobDueDate": "2025-12-10T14:56:00Z",
    "referenceNumber": "updated-ref-number-12345",
    "updatedByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "authorizedByUser": {
      "userUid": "53197ee8283d",
      "firstName": "Agent",
      "lastName": "Smith"
    },
    "targetLocales": [
      {
        "localeId": "uk-UA",
        "status": "IN_PROGRESS",
        "description": "Ukrainian (Ukraine) [uk-UA]"
      },
      {
        "localeId": "de-DE",
        "status": "IN_PROGRESS",
        "description": "German (Germany) [de-DE]"
      },
      {
        "localeId": "fr-FR",
        "status": "IN_PROGRESS",
        "description": "French (France) [fr-FR]"
      },
      {
        "localeId": "fr",
        "status": "IN_PROGRESS",
        "description": "French (International) [fr]"
      },
      {
        "localeId": "es",
        "status": "IN_PROGRESS",
        "description": "Spanish (International) [es]"
      }
    ],
    "files": [
      {
        "fileUri": "strings-34.properties",
        "fileUid": "4673cb60768c",
        "localeIds": [
          "uk-UA",
          "de-DE",
          "fr",
          "fr-FR",
          "es"
        ]
      },
      {
        "fileUri": "strings-33.properties",
        "fileUid": "c9b4b7c73a52",
        "localeIds": [
          "uk-UA",
          "de-DE",
          "fr",
          "fr-FR",
          "es"
        ]
      }
    ]
  }
}
Related Articles
Did this answer your question?