List Webhook Endpoints

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

Retrieve a list of all webhook endpoints registered to your account, providing details for each endpoint.

Request History

TIME	STATUS	USER AGENT
Make a request to see history.

0 Requests This Month

cURL Request

shell

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

Response

Response Structure

Field	Type	Description
data	array	Array of registered webhook endpoint objects
endpoints[].endpoint_id	string	Unique identifier of the webhook endpoint
endpoints[].url	string	Callback URL of the webhook endpoint
endpoints[].secret	string	Secret key used to verify the authenticity of webhook callbacks
endpoints[].status	string	Current status of the endpoint (e.g., enabled/disabled)
endpoints[].events	array[string]	List of event types the endpoint listens to; empty or None means all events
endpoints[].username	string	Username associated with the endpoint
endpoints[].created_at	datetime	Timestamp of when the endpoint was created

Sample Response

json

{
  "data": [
    {
      "endpoint_id": "webhook_123456",
      "url": "https://example.com/webhook",
      "secret": "whsec_abc123",
      "status": "enabled",
      "events": ["video.completed", "avatar.generated"],
      "username": "user123",
      "created_at": "2024-01-15T10:30:00Z"
    },
    {
      "endpoint_id": "webhook_789012",
      "url": "https://mysite.com/callback",
      "secret": "whsec_def456",
      "status": "disabled",
      "events": [],
      "username": "user123",
      "created_at": "2024-01-10T15:45:00Z"
    }
  ]
}

Notes

Requires API authentication.
Returns all webhook endpoints registered to your account.
Each endpoint includes its configuration and status.
Secret keys are included for webhook verification.
Event filters show which events each endpoint receives.
Empty events array means the endpoint receives all events.
Status indicates if the endpoint is currently active.
Refer to Error Responses for error information.

Example Usage

Shell

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

LANGUAGE

CREDENTIALS

Header

HEADER

RESPONSE

Examples

Choose an example:

application/json

200 - Success

401 - Unauthorized

Delete Asset Add Webhook Endpoint