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>'
{
  "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