Project
Set Webhook for video_status
This endpoint sets up a webhook for getting the status of the videos.
Videos are created in batches. We will do a POST request to the webhook that you would provide us. The payload is shown below.
{
'abc123': {
'video_url':'<Video_S3_URL>',
'status':True,
'inference_id': 'Inference_Id'
},
'avs3456': {
'status': False,
'inference_id':'3eeb8a96-94fa-4c1b-b827-20dc6a2a0c3c',
'error': {
'status_code': 503,
'message': 'Failed to generate video for inference id:3eeb8a96-94fa-4c1b-b827-20dc6a2a0c3c. Please try again later!'
}
}
}
In the above example, video was successfully generated for unique_id 'abc123'
and is ready for download. Video could not be generated for unique_id 'avs3456'
. We will return error details
POST
/
projects
/
{project_id}
/
webhook
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
project_id
string
requiredThe project_id for which the webhook needs to be set.
Body
application/json
enable
boolean
default: truerequiredurl
string
requiredThe url of your webhook.
Authorization
string
default: Bearer <Insert_the_token_here>The token must follow the bearer
format.
Response
200 - application/json
enable
boolean
default: truerequiredurl
string
requiredThe url of your webhook.
Authorization
string
default: Bearer <Insert_the_token_here>The token must follow the bearer
format.
user_identifier
string
requireduser_password
string
requiredmessage
string
requiredsend_query_params
boolean
requiredsend_replacement
boolean
requiredserialize_payload
boolean
requiredtags_mapping
object
required