Callbacks
Interactive API documentation is available here: api-docs.captionhub.com
Callbacks
When you pass a status_callback_url to the project creation endpoint, you will receive callbacks when certain project actions take place.
All callbacks are sent as POST requests with a JSON payload
When the project has been encoded:
{
"message": "projectEncodeState",
"projectEncoded": true,
"projectId": 174882
}
When automatic transcription is complete:
{
"message": "automaticTranscriptionComplete",
"projectId": 174882
}
If transcription fails:
{
"message": "automaticTranscriptionFailed",
"projectId": 174882
}
When an automatic alignment is completed:
{ "message": "automaticAlignmentComplete", "projectId": 174882 }
When a caption set is approved
{
"project": {
"id": 174882,
"name": "From API"
},
"captionSet": {
"captionSetId": 1772532,
"language": {
"name": "French",
"code": "FR"
}
},
"message": "captionSetApproved"
}
When a caption set is unapproved
{ "project": { "id": 174882, "name": "From API" }, "captionSet": { "captionSetId": 1772532, "language": { "name": "French", "code": "FR" } }, "message": "captionSetUnapproved" }
Did this answer your question?
😞
😐
🤩