Knowledge Base

Documentation on how to translate software with POEditor

Webhooks are user-defined HTTP callbacks, which can be maintained, modified and managed by any third-party users, in order to cause events on one site to invoke behavior on another.

Webhooks can be called from anywhere. They can be added in a GitHub repo's settings, to be called by one or more events taking place in the repo at a given time. If the webhook is added to GitHub, its operations will take effect every time the selected event takes place, regardless of the branch determining the event.

When the webhook is triggered, the assigned languages/projects on POEditor receive data from the GitHub file that is connected to it.

URL Example

https://poeditor.com/api/webhooks/github?api_token=a9824103d8729b923fbe1d268ec69ef9&id_project=7717&language=en&operation=import_translations

  • api_token (required) - you can get this key from your POEditor account. You'll find it in My Account > API Access.
  • id_project (required) - the id of project. You'll find it in My Account > API Access.
  • language (required) - language code. You'll find it in My Account > API Access.
  • operation (required) - can be one of the following:
    • get_terms - brings the terms from connected file on GitHub to the POEditor project
    • import_translations - brings the translations from the file on GitHub repo to the linked language in the POEditor project
    • import_terms_and_translations - brings new terms from the file on GitHub repo to the POEditor project, also adding translations to the linked language
    • export_terms_and_translations - sends terms and translations from POEditor to the linked file on GitHub
    • sync_terms_and_translations - gets the terms and translations from GitHub repo and removes obsolete terms from POEditor
  • overwrite_translations (optional) - when importing translations to POEditor, set it to 1 in order to overwrite existing translations

In the GitHub integration page, you can find a webhook generator.

Notes: 1) The export option can be triggered from anywhere, except GitHub. 2) How your webhook behaves is determined by your Advanced export options.