Webhooks or web callback or HTTP push API is a way for an app to provide other applications with real-time information.
Webhooks are basically user-defined HTTP callbacks (or small code snippets linked to a web application) that are triggered by specific events. Whenever that trigger event occurs in the source site, the webhook sees the event, collects the data, and sends it to the URL specified by you in the form of an HTTP request.
Consuming a Webhook
The first step in consuming a webhook is giving the webhook provider a URL to deliver requests to. This is most often done through a backend panel or an API. This means that you also need to set up a URL in your app that’s accessible from the public web.
Webhooks in Verbit
Webhook URL can be set up in your MY ACCOUNT to receive Verbit notifications.
Webhook URL can be set up in your customer profile to receive Verbit notifications once the job is finished.
Here are the requirements:
It should be HTTP POST endpoint on your server, accessible without any authentication (or authentication params could be included in the webhook URL);
It will receive a POST request with form-encoded payload (you can use the SEND TEST EVENT button in your MY ACCOUNT to receive sample payload immediately):
job_id="<verbit internal job id, returned from /transcription_jobs/new>"& external_id="<your job id you have passed to /transcription_jobs/new>"& status="'Completed' or 'Failure'"
if the call is successfully consumed, the endpoint should respond with a body consisting of
"OK"(without quotes) and nothing else;
if the call was not successful (e.g. not returned
"OK"body), Verbit platform will do several retries with a gradually increased wait period, up to 48 hours since the first fail.
NOTE: Currently, only one webhook URL per customer can be configured.