Callbacks - Parameters
The Callback URL is called with these URL parameters:
URL Parameter | Description |
---|---|
bbid | The unique event id (an alphanumeric ID). Use this ID to fetch full event details, for example to obtain the list of newly delivered translated files. See API - Full event details |
bbevent | The type of event. To simply track additions of new source files and creation of new translated files then please simply listen to these two events: "Source File Parse "and" Created Translated Files". Please refer to Beebox Recent Events page for the list of all event types. Connector callbacks (see Callbacks - Connector Callbacks) are triggered for this event only:
Admin callbacks are triggered for any kind of event, among the most important are:
|
bbsender | The origin at or of the event. Can be either "Admin" (Administrator), "Plugin" (Standard plugin), "Plugin Ext" (Advanced Plugin) or "Autorun" (Autorun operation). For example, if your connector sends a new file, the URL will be called and inform of the addition of a new file. In other words, you will receive all type of events even those you had triggered yourself. |
bbproject | The project key. |
bbdate | The UTC date/time of the event. ISO 8601 formatted such as "2007-04-05T14:30Z" or "2007-04-05T12:30-02:00". |
bbok | Either "true" or "false". Indicates if the operation triggering this event was successful or failed. |
bberror | Error message if the operation had failed. |
The table below lists all event types:
Event code | Description |
File related events | |
SourceFileChange | New source files added or updated in the project. |
SourceFileParse | Source files processed. This refers to extracting text content from the files and pre-translation from memories. All segments are now available in the Beebox project. If a source file failed to process bberror will be set. |
CreatedTranslatedFiles | New translated file or files created and saved to disk. |
CreatedPreliminaryFiles | Preliminar machine translated target files are created. Preliminary files can be enabled in the "Automation" tab of the project settings page. These are raw machine-translated versions before unapproved segments are sent to a human translation workflow. |
Job events | |
PackageCreated | New job created and committed. |
PackageInProgress | Xliffjobsonly.Job in progress. |
PackageCompleted | Xliffjobsonly.Job completed. |
PackageXliffExport | Xliffjobsonly.Job xliff saved to exchange output directory. This event is raised if the hot folder mechanism for xliff exchange is enabled in a project. |
PackageXliffImport | Xliffjobsonly.Job updated from new xliff available in the exchange input directory. This event is raised if the hot folder mechanism for xliff exchange is enabled in a project. |
PackageTmsSubmitRequ est | Online jobsonly. Submitted job to TMS to obtain cost or word count. |
PackageTmsCommitReq uest | Online jobs only. Commit previous request to TMS. Work now starts. |
PackageTmsCheckResul tsDone | Online jobs only. Ask TMS if job results are done and can be downloaded. |
PackageTmsDownloadR esults | Online jobs only. Downloads results from TMS. |
PackageTmsCancelRequ est | Online jobs only. Cancel job. |
PackageContentsApprov ed | Translations in a job are approved. This typically happens after translations are imported from an xliff or the TMS. |
PackageContentApplyCh anges | Apply various changes to job contents (flags, translation, etc.) |
PackagePseudoTranslat ed | Job content was fully or partially machine or pseudotranslated. |
PackageContentsApplied | Commits a job. This means that translations were imported from xliff or the TMS and are now applied to the Beebox project memory. Once this is done, the source files can subsequently be translated. A committed job aIready to be closed. |
PackageCancelled | Cancel package. |
PackageClosed | Close package. |
PackageDeleted | Delete package. |
PackageReopened | Reopen package. |
TMS connections | |
TmsSendLinkRequest | Occurs when a link to a TMS is created in a project. At this stage the link is not established and operational but pending approval by the TMS owner. |
TmsSendMessage | Send a message to the TMS owner. |
TmsDeleteLink | Delete TMS link. |
Project related events | |
ProjectUpdate | Project details were updated. |
ProjectDeleted | Project was deleted. |
ProjectCreated | A new project was created. |
ContentApplyChanges | Apply various changes to the project memory contents (flags, translation, etc.) |
PseudoTranslated | Project memory was fully or partially machine or pseudo translated. |
ProjectMemoryDeleteAll | Delete all contents from the project memory. |
ProjectMemoryDeleteFile | Delete the content of a single file from the project memory. |
Administration | |
AccountUpdated | Beebox account details updated (name, login, password etc.) |
ServerReset | Admin did a Beebox reset. This logs out all users and clears any cached data from memory. |
AutorunEnabled | The Autorun operations for a project are enabled. |
AutorunDisabled | The Autorunoperationsfora projectaredisabled. |
AutorunFatalError | An Autorun operation in a project exited with a fatal error. Such event should never occur. Error details should be looked up in the Windows event log. |
AutorunExitFailed | The process running automatic operations terminated due to a non-fatal error. Such event should never occur. |
AutorunExitEnded | The process running automatic operations terminated with success. This only occurs when the Beebox server or service is restarted or stopped. |
Maintenance | A generic maintenance related event type. |
Copyright Wordbee - Buzzin' Outside the Box since 2008