List Available Webhook Events

GEThttps://api.konpro.ai/v1/webhook/webhook.list

Retrieve a list of all supported webhook event types that your application can subscribe to for real-time notifications.

Request History

Log in to see full request history

TIMESTATUSUSER AGENT
Make a request to see history.

0 Requests This Month

cURL Request

shell
curl --request GET \
--url https://api.konpro.ai/v1/webhook/webhook.list \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

Response

Response Structure

FieldTypeDescription
dataarray[string]Array of supported webhook event names

Sample Response

json
{
  "data": [
    "video.created",
    "video.updated",
    "video.deleted",
    "avatar.created",
    "avatar.updated",
    "avatar.deleted",
    "session.started",
    "session.ended",
    "task.completed",
    "task.failed"
  ]
}

Notes

  • Requires API authentication.
  • Returns all available webhook event types.
  • Event names follow dot notation format (e.g., "video.created").
  • Use these event names when creating webhook endpoints.
  • Event list may change with API updates.
  • Some events may require specific permissions.
  • Event payloads vary by event type.
  • Refer to Error Responses for error information.

Example Usage

Shell
curl --request GET \
--url https://api.konpro.ai/v1/webhook/webhook.list \
--header 'accept: application/json' \
--header 'x-api-key: <your-api-key>'

LANGUAGE

CREDENTIALS

HEADER

RESPONSE

Examples

Choose an example:

application/json
200 - Success
401 - Unauthorized