Rest API

Register Webhook

Register a new webhook for receiving callbacks from transcribing events

POST /webhooks/create

callback_urlformstring-The URL for the callback
include_partialsformbooleanfalseWhether to return live paetial transcripts
include_livesformbooleantrueWhether to return final live transcripts
include_editsformbooleanfalseWhether to return human-edited transcripts
include_extrasformbooleanfalseWhether to return metadata, like speaker ID
relevanceformstringuserPossible values: user, org, global
headersformstringnullComma-separated list of headers to send
usernameformstringnullUsername for simple auth, if needed
passwordformstringnullPassword for simple auth, if needed


  • Make sure the callback_url can accept POST requests
  • relevance allows you to scope the webhook callback events to a user only, entire organization, or everything (global). The user and org options are meant to be used for private events created in Aiera.

WARNING: the global option is a firehose where the callback_url will be hit from ALL transcribing events


  "webhook_id": 1

Code Samples


  curl --request POST \
  --url 'null/api/speech-v1/webhooks/create' \
  --header 'X-API-Key: xxx'
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'callback_url=CALLBACK_URL&include_lives=true'


import requests
    headers={"X-API-Key": "xxx"},
        "callback_url": CALLBACK_URL,
        "include_lives": true
Disconnect Event