Skip to main content
GET
/
v1
/
public
/
webhook
/
subscription
/
{id}
Get a subscription
curl --request GET \
  --url https://api.example.com/v1/public/webhook/subscription/{id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/v1/public/webhook/subscription/{id}"

headers = {"Authorization": "Bearer <token>"}

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

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

fetch('https://api.example.com/v1/public/webhook/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://api.example.com/v1/public/webhook/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: Bearer <token>"
],
]);

$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://api.example.com/v1/public/webhook/subscription/{id}"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/v1/public/webhook/subscription/{id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/public/webhook/subscription/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "id": "6a27a76692d9e3a8ffd7e62d",
  "organization_id": "ddd6f1d8-b232-497e-bf1e-ea7317622d17",
  "scope": "ORGANIZATION",
  "created_user_id": "google-oauth2|101090478854418701727",
  "name": "Payment Events Webhook",
  "url": "https://api.example.com/webhooks/payments",
  "events": [],
  "active": true,
  "headers": {
    "X-Custom-Header": "custom-value",
    "Authorization": "Bearer your-api-token-here"
  },
  "description": "Receives payment events with custom authentication",
  "request_timeout_ms": 1000,
  "retry_policy": {
    "retryStrategy": "FIXED_DELAY",
    "maxRetryAttempts": 3,
    "maxRetryDelayMs": 10000
  },
  "signing_enabled": true,
  "created_at": "2026-06-09T10:15:00.000Z",
  "updated_at": "2026-06-09T10:15:00.000Z"
}
{
"error": "Authentication",
"message": "Authentication failed",
"traceId": "e679120f-1d1c-41d2-947c-34e194d5a4a1"
}
{
"status": 400,
"type": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {},
"timestamp": "2023-11-07T05:31:56Z",
"path": "/v1/public/webhook/subscription",
"trace_id": "341b5325-a0be-4533-85dd-6f697476dfc3"
}
{
"status": 400,
"type": "VALIDATION_ERROR",
"message": "Validation failed",
"details": {},
"timestamp": "2023-11-07T05:31:56Z",
"path": "/v1/public/webhook/subscription",
"trace_id": "341b5325-a0be-4533-85dd-6f697476dfc3"
}

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header: Authorization: Bearer <YOUR_API_KEY>.

Path Parameters

id
string
required

The subscription ID.

Response

OK (no secret).

id
string

Subscription ID. Required for GET / PUT / DELETE.

Example:

"6a27a76692d9e3a8ffd7e62d"

organization_id
string

Owning organization (resolved from your API key).

Example:

"ddd6f1d8-b232-497e-bf1e-ea7317622d17"

scope
enum<string>

Resolved delivery scope.

Available options:
ORGANIZATION,
WORKSPACE,
AGENT
Example:

"ORGANIZATION"

created_user_id
string

User that created the subscription.

Example:

"google-oauth2|101090478854418701727"

name
string
Example:

"Payment Events Webhook"

url
string
Example:

"https://api.example.com/webhooks/payments"

events
string[]
Example:
[]
active
boolean
Example:

true

headers
Headers · object

Custom HTTP headers forwarded with each delivery; omitted when unset.

Example:
{
"X-Custom-Header": "custom-value",
"Authorization": "Bearer your-api-token-here"
}
description
string

Free-text description; omitted when unset.

Example:

"Receives payment events with custom authentication"

agent_ids
string[]

Agent scope; omitted when unset.

workspace_ids
string[]

Workspace scope; omitted when unset.

request_timeout_ms
integer

Per-attempt delivery timeout in ms (default 1000).

Example:

1000

retry_policy
WebhookRetryPolicy · object

Delivery retry configuration.

signing_enabled
boolean

Whether the subscription has a signing secret. Always present.

Example:

true

secret
string

HMAC signing secret, prefixed whsec_. Present only at issuance when signing is enabled. Never returned by read endpoints.

Example:

"whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at
string<date-time>
Example:

"2026-06-09T10:15:00.000Z"

updated_at
string<date-time>
Example:

"2026-06-09T10:15:00.000Z"