Edit Webhook

Edit a registered webhook

POST /webhooks/{webhook_id}/edit

Parameter	Where	Type	Default	Description
callback_url	form	string	-	The URL for the callback
include_partials	form	boolean	false	Whether to return live paetial transcripts
include_lives	form	boolean	true	Whether to return final live transcripts
include_edits	form	boolean	false	Whether to return human-edited transcripts
include_extras	form	boolean	false	Whether to return metadata, like speaker ID
relevance	form	string	user	Possible values: user, org, global
headers	form	string	null	Comma-separated list of headers to send
username	form	string	null	Username for simple auth, if needed
password	form	string	null	Password for simple auth, if needed

NOTE

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

Response

{
  "status": "success"
}

Code Samples

Bash

  curl --request POST \
  --url 'null/api/speech-v1/webhooks/{webhook_id}/edit' \
  --header 'X-API-Key: xxx'
  --data 'callback_url=CALLBACK_URL&include_lives=true'

Python

import requests
requests.post(
    f"null/api/speech-v1/webhooks/{webhook_id}/edit", 
    headers={"X-API-Key": "xxx"},
    data={
        "callback_url": CALLBACK_URL,
        "include_lives": true
    }
)