API Developers Guide

Callbacks

Some methods allow you to specify a callback URL. This URL will be used on time critical events, for example, when a translation has been received on your project.

Callback URL must be a valid and web-accessible location and must return an HTTP "200 OK" status.
All callbacks are logged and you can view the log for a specific project on the project’s page.

Please make sure to whitelist the following IPs:

Production - 107.23.108.160
Sandbox - 34.201.183.17

Callback Events:

Project > New Resource

Field Description
event project.resources.new
project_id the specific project ID
project_status_code pending | in_progress | submitted | signed | completed | cancelled | disputed | error
  • pending - project submitted to OHT, but professional worker (translator/proofreader) did not start working yet
  • in_progress - worker started working on this project
  • submitted - the worker uploaded the first target resource to the project. This does not mean that the project is completed.
  • signed - the worker declared (with his signature) that he finished working on this project and all resources have been uploaded.
  • completed - final state of the project, after which we cannot guarantee fixes or corrections. This state is automatically enforced after 4 days of inactivity on the project.
resource_uuid UUID of the newly submitted resource
resource_type translation | proof | transcription
custom0..9 custom fields that were submitted on project creation, if any.

Example (JSON):

{
"event":"project.resources.new",
"project_id":"1901",
"project_status_code":"submitted",
"resource_uuid":"rsc27a4a5d49acb61",
"resource_type":"translation",
"custom0":"test1",
"custom1":"",
"custom2":"",
"custom3":"",
"custom4":"",
"custom5":"",
"custom6":"",
"custom7":"",
"custom8":"",
"custom9":""
}

Project > Status Change

field description
event project.status.update
project_id the specific project ID
project_status_code pending | in_progress | submitted | signed | completed | cancelled | disputed | error
custom0..9 custom fields that were submitted on project creation, if any.
 

 Example (JSON):

{
 "event":"project.status.update",
 "project_id":"1901",
 "project_status_code":"signed",
 "custom0":"test1",
 "custom1":"",
 "custom2":"",
 "custom3":"",
 "custom4":"",
 "custom5":"",
 "custom6":"",
 "custom7":"",
 "custom8":"",
 "custom9":""
}

Project > Comment Submitted

field description
event project.comments.new
project_id the specific project ID
project_status_code pending | in_progress | submitted | signed | completed | cancelled | disputed | error
comment_id the specific comment ID
comment_date the specific comment's date
commenter_name the specific comment's author
commenter_role admin | customer | provider
comment_content the text in the specific comment
custom0..9 custom fields that were submitted on project creation, if any.
 

 Example (JSON):

{
 "event":"project.comments.new",
 "project_id":"1901",
 "project_status_code":"signed",
 "comment_id":"246",
 "comment_date":"2013-11-07 14:27:52",
 "commenter_name":"Trans2",
 "commenter_role":"provider",
 "comment_content":"comment text",
 "custom0":"test1",
 "custom1":"",
 "custom2":"",
 "custom3":"",
 "custom4":"",
 "custom5":"",
 "custom6":"",
 "custom7":"",
 "custom8":"",
 "custom9":""
}