You can have the Beebox call a URL whenever an event takes place in a Beebox project. Sample events you may hook:
- A translated file was created in the "out" directory
- A new source file was added to the Beebox
- A source file is invalid and could not be processed
- A translation job was sent or received
- ...
Callbacks are often used in combination with the API. For example, instead of polling the Beebox to see if files have been translated, you could use callbacks instead. Callbacks are configured individually per Beebox project. There are two types of callback urls:
- Admin callback url: Called with all Beebox events.
- Connector callback url: Called when a file is translated and ready for download.
Setup "Admin" callback
These callback urls are called with all events in the Beebox.
Select a project and click "Settings". Scroll down to the bottom of the page and paste your callback url:
Setup "Connector" callback
Connector callbacks are only triggered when translations have been completed and are ready for download (using the API).
Use case: When you link a CMS with the Beebox, the CMS uses the limited "Connector" credentials to exchange work. If you would like to notify the CMS of work completion you may want to have a specific CMS page be called. That page may then notify a CMS user or trigger the download of translations.
Connector callbacks are configured in the "Connectors & API" tab of the project "Settings" page:
As you can see the url is supplied in the same page where you supply the credentials for the CMS or other external system.