Skip to main content
GET
/
v1
/
webhook-subscriptions
/
{subscription_id}
Retrieve a webhook subscription
curl --request GET \
  --url https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id} \
  --header 'Authorization: <api-key>'
import requests

url = "https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id}")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "agent_id": "<string>",
  "url": "<string>",
  "events": [],
  "enabled": true,
  "secret_version": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"detail": "Unauthorized"
}
{
"detail": "Unauthorized"
}

Authorizations

Authorization
string
header
required

Your AssemblyAI API key in the Authorization header (raw key; a Bearer prefix is also accepted).

Path Parameters

subscription_id
string
required
Example:

"0d75ebd7-937c-495c-b638-ba582ec05b39"

Response

The subscription.

A subscription. The signing secret is never returned, only its version.

id
string
agent_id
string | null
url
string
events
enum<string>[]
Available options:
session.started,
session.completed,
call.connected,
call.ended,
call.failed
enabled
boolean
secret_version
integer
Example:

1

created_at
string<date-time>
updated_at
string<date-time>