Webhook Events (String-based)

You can add webhooks to build integrations with the third-party services or with your backend. After you configure a webhook for the project, Crowdin will start sending POST or GET requests with data to the webhook URL via HTTP.

Events

In string-based projects, you can configure webhooks for the following types of events:

Webhook Payload Examples

Project fully translated

{
  "event": "project.translated",
  "project": {
    "id": "777",
    "userId": "1",
    "sourceLanguageId": "en",
    "targetLanguageIds": [
      "uk",
      "pl"
    ],
    "identifier": "umbrella-sb",
    "name": "Project Name",
    "createdAt": "2022-04-20T11:05:24+00:00",
    "updatedAt": "2022-04-21T11:07:29+00:00",
    "lastActivity": "2022-04-21T11:07:29+00:00",
    "description": "Project Description",
    "url": "https://crowdin.com/project/umbrella-sb",
    "cname": null,
    "languageAccessPolicy": "moderate",
    "visibility": "private",
    "publicDownloads": true
  },
  "targetLanguage": {
    "id": "es",
    "name": "Spanish",
    "editorCode": "es",
    "twoLettersCode": "es",
    "threeLettersCode": "spa",
    "locale": "es-ES",
    "androidCode": "es-rES",
    "osxCode": "es.lproj",
    "osxLocale": "es",
    "textDirection": "ltr",
    "dialectOf": null
  }
}

Project fully reviewed

{
  "event": "project.approved",
  "project": {
    "id": "777",
    "userId": "1",
    "sourceLanguageId": "en",
    "targetLanguageIds": [
      "uk",
      "pl"
    ],
    "identifier": "umbrella-sb",
    "name": "Project Name",
    "createdAt": "2022-04-20T11:05:24+00:00",
    "updatedAt": "2022-04-21T11:07:29+00:00",
    "lastActivity": "2022-04-21T11:07:29+00:00",
    "description": "Project Description",
    "url": "https://crowdin.com/project/umbrella-sb",
    "cname": null,
    "languageAccessPolicy": "moderate",
    "visibility": "private",
    "publicDownloads": true
  },
  "targetLanguage": {
    "id": "es",
    "name": "Spanish",
    "editorCode": "es",
    "twoLettersCode": "es",
    "threeLettersCode": "spa",
    "locale": "es-ES",
    "androidCode": "es-rES",
    "osxCode": "es.lproj",
    "osxLocale": "es",
    "textDirection": "ltr",
    "dialectOf": null
  }
}

Exported translation updated

{
  "event": "translation.updated",
  "oldTranslation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00"
  },
  "newTranslation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00",
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    }
  }
}

Source string added

{
  "events": [
    {
      "event": "string.added",
      "string": {
        "id": "2814",
        "identifier": "b068931cc450442b63f5b3d276ea4297",
        "key": "name",
        "text": "Not all videos are shown to users. See more",
        "type": "text",
        "context": "shown on main page",
        "maxLength": "35",
        "isHidden": false,
        "isDuplicate": true,
        "masterStringId": "1",
        "hasPlurals": false,
        "labelIds": [
          3,
          8
        ],
        "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
        "createdAt": "2022-04-20T12:43:57+00:00",
        "updatedAt": "2022-04-20T13:24:01+00:00",
        "branch": {
          "id": "34"
        },
        "project": {
          "id": "627210",
          "userId": "1",
          "sourceLanguageId": "en",
          "targetLanguageIds": [
            "uk",
            "pl"
          ],
          "identifier": "umbrella-sb",
          "name": "Project Name",
          "createdAt": "2022-04-20T11:05:24+00:00",
          "updatedAt": "2022-04-21T11:07:29+00:00",
          "lastActivity": "2022-04-21T11:07:29+00:00",
          "description": "Project Description",
          "url": "https://example.crowdin.com/u/projects/627210",
          "cname": null,
          "languageAccessPolicy": "moderate",
          "visibility": "private",
          "publicDownloads": true
        }
      },
      "user": {
        "id": "1",
        "username": "john_smith",
        "fullName": "John Smith",
        "avatarUrl": ""
      }
    }
  ]
}

Source string updated

{
  "events": [
    {
      "event": "string.updated",
      "string": {
        "id": "2814",
        "identifier": "b068931cc450442b63f5b3d276ea4297",
        "key": "name",
        "text": "Not all videos are shown to users. See more",
        "type": "text",
        "context": "shown on main page",
        "maxLength": "35",
        "isHidden": false,
        "isDuplicate": true,
        "masterStringId": "1",
        "hasPlurals": false,
        "labelIds": [
          3,
          8
        ],
        "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
        "createdAt": "2022-04-20T12:43:57+00:00",
        "updatedAt": "2022-04-20T13:24:01+00:00",
        "branch": {
          "id": "34"
        },
        "project": {
          "id": "627210",
          "userId": "1",
          "sourceLanguageId": "en",
          "targetLanguageIds": [
            "uk",
            "pl"
          ],
          "identifier": "umbrella-sb",
          "name": "Project Name",
          "createdAt": "2022-04-20T11:05:24+00:00",
          "updatedAt": "2022-04-21T11:07:29+00:00",
          "lastActivity": "2022-04-21T11:07:29+00:00",
          "description": "Project Description",
          "url": "https://example.crowdin.com/u/projects/627210",
          "cname": null,
          "languageAccessPolicy": "moderate",
          "visibility": "private",
          "publicDownloads": true
        }
      },
      "user": {
        "id": "1",
        "username": "john_smith",
        "fullName": "John Smith",
        "avatarUrl": ""
      }
    }
  ]
}

Source string deleted

{
  "events": [
    {
      "event": "string.deleted",
      "string": {
        "id": "2814",
        "identifier": "b068931cc450442b63f5b3d276ea4297",
        "key": "name",
        "text": "Not all videos are shown to users. See more",
        "type": "text",
        "context": "shown on main page",
        "maxLength": "35",
        "isHidden": false,
        "isDuplicate": true,
        "masterStringId": "1",
        "hasPlurals": false,
        "labelIds": [
          3,
          8
        ],
        "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
        "createdAt": "2022-04-20T12:43:57+00:00",
        "updatedAt": "2022-04-20T13:24:01+00:00",
        "branch": {
          "id": "34"
        },
        "project": {
          "id": "627210",
          "userId": "1",
          "sourceLanguageId": "en",
          "targetLanguageIds": [
            "uk",
            "pl"
          ],
          "identifier": "umbrella-sb",
          "name": "Project Name",
          "createdAt": "2022-04-20T11:05:24+00:00",
          "updatedAt": "2022-04-21T11:07:29+00:00",
          "lastActivity": "2022-04-21T11:07:29+00:00",
          "description": "Project Description",
          "url": "https://example.crowdin.com/u/projects/627210",
          "cname": null,
          "languageAccessPolicy": "moderate",
          "visibility": "private",
          "publicDownloads": true
        }
      },
      "user": {
        "id": "1",
        "username": "john_smith",
        "fullName": "John Smith",
        "avatarUrl": ""
      }
    }
  ]
}

Suggested translation added

{
  "event": "suggestion.added",
  "translation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00",
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    }
  }
}

Suggested translation updated

{
  "event": "suggestion.updated",
  "translation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00",
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    }
  }
}

Suggested translation deleted

{
  "event": "suggestion.deleted",
  "translation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00",
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    }
  }
}

Suggested translation approved

{
  "event": "suggestion.approved",
  "translation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00",
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    }
  }
}

Suggested translation disapproved

{
  "event": "suggestion.disapproved",
  "translation": {
    "id": "1",
    "text": "1",
    "pluralCategoryName": "1",
    "rating": "10",
    "provider": null,
    "isPreTranslated": false,
    "createdAt": "2022-05-05T11:26:54+00:00",
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    }
  }
}

String comment/issue created

{
  "event": "stringComment.created",
  "comment": {
    "id": "12",
    "text": "@BeMyEyes  Please provide more details on where the text will be used",
    "type": "issue",
    "issueType": "source_mistake",
    "issueStatus": "unresolved",
    "resolvedAt": "2019-09-20T11:05:24+00:00",
    "createdAt": "2019-09-20T11:05:24+00:00",
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "commentResolver": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

String comment/issue updated

{
  "event": "stringComment.updated",
  "comment": {
    "id": "12",
    "text": "@BeMyEyes  Please provide more details on where the text will be used",
    "type": "issue",
    "issueType": "source_mistake",
    "issueStatus": "unresolved",
    "resolvedAt": "2019-09-20T11:05:24+00:00",
    "createdAt": "2019-09-20T11:05:24+00:00",
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "commentResolver": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

String comment/issue deleted

{
  "event": "stringComment.deleted",
  "comment": {
    "id": "12",
    "text": "@BeMyEyes  Please provide more details on where the text will be used",
    "type": "issue",
    "issueType": "source_mistake",
    "issueStatus": "unresolved",
    "resolvedAt": "2019-09-20T11:05:24+00:00",
    "createdAt": "2019-09-20T11:05:24+00:00",
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "commentResolver": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

String comment/issue restored

{
  "event": "stringComment.restored",
  "comment": {
    "id": "12",
    "text": "@BeMyEyes  Please provide more details on where the text will be used",
    "type": "issue",
    "issueType": "source_mistake",
    "issueStatus": "unresolved",
    "resolvedAt": "2019-09-20T11:05:24+00:00",
    "createdAt": "2019-09-20T11:05:24+00:00",
    "string": {
      "id": "2814",
      "identifier": "b068931cc450442b63f5b3d276ea4297",
      "key": "name",
      "text": "Not all videos are shown to users. See more",
      "type": "text",
      "context": "shown on main page",
      "maxLength": "35",
      "isHidden": false,
      "isDuplicate": true,
      "masterStringId": "1",
      "hasPlurals": false,
      "labelIds": [
        3,
        8
      ],
      "url": "https://example.crowdin.com/translate/umbrella-sb/1/en-uk/78#1",
      "createdAt": "2022-04-20T12:43:57+00:00",
      "updatedAt": "2022-04-20T13:24:01+00:00",
      "branch": {
        "id": "34"
      },
      "project": {
        "id": "627210",
        "userId": "1",
        "sourceLanguageId": "en",
        "targetLanguageIds": [
          "uk",
          "pl"
        ],
        "identifier": "umbrella-sb",
        "name": "Project Name",
        "createdAt": "2022-04-20T11:05:24+00:00",
        "updatedAt": "2022-04-21T11:07:29+00:00",
        "lastActivity": "2022-04-21T11:07:29+00:00",
        "description": "Project Description",
        "url": "https://example.crowdin.com/u/projects/627210",
        "cname": null,
        "languageAccessPolicy": "moderate",
        "visibility": "private",
        "publicDownloads": true
      }
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "user": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    },
    "commentResolver": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

Task added

{
  "event": "task.added",
  "task": {
    "id": "1",
    "type": "1",
    "vendor": "gengo",
    "status": "todo",
    "title": "French",
    "assignees": [
      {
        "id": 1,
        "username": "john_smith",
        "fullName": "John Smith",
        "avatarUrl": "",
        "wordsCount": 5,
        "wordsLeft": 3
      }
    ],
    "assignedTeams": [
      {
        "id": 1,
        "wordsCount": 5
      }
    ],
    "branchIds": "",
    "progress": {
      "total": 24,
      "done": 15,
      "percent": 2
    },
    "description": "Proofread all French strings",
    "translationUrl": "https://example.crowdin.com/proofread/9092638ac9f2a2d1b5571d08edc53763/all/en-fr/10?task=dac37aff364d83899128e68afe0de4994",
    "wordsCount": "24",
    "commentsCount": "0",
    "deadline": "2022-08-23T18:00:00+00:00",
    "timeRange": "2022-04-09 00:00:00|2022-05-08 23:59:59",
    "workflowStepId": "10",
    "buyUrl": "https://www.paypal.com/cgi-bin/webscr?cmd=...",
    "createdAt": "2022-05-23T16:14:18+00:00",
    "updatedAt": "2022-05-23T18:02:19+00:00",
    "sourceLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "project": {
      "id": "627210",
      "userId": "1",
      "sourceLanguageId": "en",
      "targetLanguageIds": [
        "uk",
        "pl"
      ],
      "identifier": "umbrella-sb",
      "name": "Project Name",
      "createdAt": "2022-04-20T11:05:24+00:00",
      "updatedAt": "2022-04-21T11:07:29+00:00",
      "lastActivity": "2022-04-21T11:07:29+00:00",
      "description": "Project Description",
      "url": "https://example.crowdin.com/u/projects/627210",
      "cname": null,
      "languageAccessPolicy": "moderate",
      "visibility": "private",
      "publicDownloads": true
    },
    "taskCreator": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

Task status changed

{
  "event": "task.statusChanged",
  "task": {
    "id": "1",
    "type": "1",
    "vendor": "gengo",
    "status": "todo",
    "title": "French",
    "assignees": [
      {
        "id": 1,
        "username": "john_smith",
        "fullName": "John Smith",
        "avatarUrl": "",
        "wordsCount": 5,
        "wordsLeft": 3
      }
    ],
    "assignedTeams": [
      {
        "id": 1,
        "wordsCount": 5
      }
    ],
    "branchIds": "",
    "progress": {
      "total": 24,
      "done": 15,
      "percent": 2
    },
    "description": "Proofread all French strings",
    "translationUrl": "https://example.crowdin.com/proofread/9092638ac9f2a2d1b5571d08edc53763/all/en-fr/10?task=dac37aff364d83899128e68afe0de4994",
    "wordsCount": "24",
    "commentsCount": "0",
    "deadline": "2022-08-23T18:00:00+00:00",
    "timeRange": "2022-04-09 00:00:00|2022-05-08 23:59:59",
    "workflowStepId": "10",
    "buyUrl": "https://www.paypal.com/cgi-bin/webscr?cmd=...",
    "createdAt": "2022-05-23T16:14:18+00:00",
    "updatedAt": "2022-05-23T18:02:19+00:00",
    "oldStatus": "todo",
    "newStatus": "in_progress",
    "sourceLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "project": {
      "id": "627210",
      "userId": "1",
      "sourceLanguageId": "en",
      "targetLanguageIds": [
        "uk",
        "pl"
      ],
      "identifier": "umbrella-sb",
      "name": "Project Name",
      "createdAt": "2022-04-20T11:05:24+00:00",
      "updatedAt": "2022-04-21T11:07:29+00:00",
      "lastActivity": "2022-04-21T11:07:29+00:00",
      "description": "Project Description",
      "url": "https://example.crowdin.com/u/projects/627210",
      "cname": null,
      "languageAccessPolicy": "moderate",
      "visibility": "private",
      "publicDownloads": true
    },
    "taskCreator": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

Task deleted

{
  "event": "task.deleted",
  "task": {
    "id": "1",
    "type": "1",
    "vendor": "gengo",
    "status": "todo",
    "title": "French",
    "assignees": [
      {
        "id": 1,
        "username": "john_smith",
        "fullName": "John Smith",
        "avatarUrl": "",
        "wordsCount": 5,
        "wordsLeft": 3
      }
    ],
    "assignedTeams": [
      {
        "id": 1,
        "wordsCount": 5
      }
    ],
    "branchIds": "",
    "progress": {
      "total": 24,
      "done": 15,
      "percent": 2
    },
    "description": "Proofread all French strings",
    "translationUrl": "https://example.crowdin.com/proofread/9092638ac9f2a2d1b5571d08edc53763/all/en-fr/10?task=dac37aff364d83899128e68afe0de4994",
    "wordsCount": "24",
    "commentsCount": "0",
    "deadline": "2022-08-23T18:00:00+00:00",
    "timeRange": "2022-04-09 00:00:00|2022-05-08 23:59:59",
    "workflowStepId": "10",
    "buyUrl": "https://www.paypal.com/cgi-bin/webscr?cmd=...",
    "createdAt": "2022-05-23T16:14:18+00:00",
    "updatedAt": "2022-05-23T18:02:19+00:00",
    "sourceLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "targetLanguage": {
      "id": "es",
      "name": "Spanish",
      "editorCode": "es",
      "twoLettersCode": "es",
      "threeLettersCode": "spa",
      "locale": "es-ES",
      "androidCode": "es-rES",
      "osxCode": "es.lproj",
      "osxLocale": "es",
      "textDirection": "ltr",
      "dialectOf": null
    },
    "project": {
      "id": "627210",
      "userId": "1",
      "sourceLanguageId": "en",
      "targetLanguageIds": [
        "uk",
        "pl"
      ],
      "identifier": "umbrella-sb",
      "name": "Project Name",
      "createdAt": "2022-04-20T11:05:24+00:00",
      "updatedAt": "2022-04-21T11:07:29+00:00",
      "lastActivity": "2022-04-21T11:07:29+00:00",
      "description": "Project Description",
      "url": "https://example.crowdin.com/u/projects/627210",
      "cname": null,
      "languageAccessPolicy": "moderate",
      "visibility": "private",
      "publicDownloads": true
    },
    "taskCreator": {
      "id": "1",
      "username": "john_smith",
      "fullName": "John Smith",
      "avatarUrl": ""
    }
  }
}

Configuring Webhooks

Only owners and project managers can register a webhook. Read about Webhooks configuration in the Knowledge Base:

Depending on your approach to webhooks management, you might need to add dedicated Crowdin IP addresses to your firewall to allow Crowdin to open the pre-configured webhook URLs.

Read more about IP Addresses.

Seeking Assistance

Need help working with Webhooks or have any questions? Contact Support Team.

Was this article helpful?