Skip to main content
GET
/
v2
/
endpoints
List Webhook Endpoints
curl --request GET \
  --url https://api.jogg.ai/v2/endpoints \
  --header 'x-api-key: <api-key>'
import requests

url = "https://api.jogg.ai/v2/endpoints"

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

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

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

fetch('https://api.jogg.ai/v2/endpoints', 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.jogg.ai/v2/endpoints",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <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://api.jogg.ai/v2/endpoints"

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

req.Header.Add("x-api-key", "<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://api.jogg.ai/v2/endpoints")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.jogg.ai/v2/endpoints")

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

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

response = http.request(request)
puts response.read_body
{
  "code": 0,
  "msg": "Success",
  "data": {
    "endpoints": [
      {
        "endpoint_id": "wh_123456789",
        "url": "https://your-domain.com/webhook",
        "secret": "whsec_abc123xyz",
        "status": "enabled",
        "events": [
          "generated_avatar_video_success",
          "generated_avatar_video_failed"
        ],
        "username": "johndoe",
        "created_at": 1732806631
      }
    ]
  }
}
Retrieve a list of all webhook endpoints configured in your account. Webhooks allow you to receive real-time notifications about events in your JoggAI workspace.
Limit: Each user can create up to 20 webhook endpoints.

Use Cases

  • View all configured webhook endpoints
  • Manage event subscriptions
  • Monitor webhook status
  • Check enabled/disabled endpoints

Response Fields

FieldTypeDescription
endpoint_idstringUnique webhook endpoint identifier
urlstringWebhook receiver URL
secretstringSecret key for signature verification
statusstringEndpoint status: enabled or disabled
eventsarrayList of subscribed event types
created_atintegerCreation timestamp

Best Practices

Regularly check webhook endpoint status to ensure critical event endpoints are enabled.
If you no longer need a webhook, we recommend using Delete Webhook Endpoint to remove it and free up your quota.

Authorizations

x-api-key
string
header
required

API key for authentication. Obtain your key from the JoggAI dashboard.

Response

200 - application/json

Success

code
integer
required

Business status code:

  • 0 - Success
  • 10104 - Record not found
  • 10105 - Invalid API key
  • 18020 - Insufficient credit
  • 18025 - No permission to call APIs
  • 40000 - Parameter error
  • 50000 - System error
Example:

0

msg
string
required

Response message

Example:

"Success"

data
object