Update a Webhook Endpoint

PATCHhttps://api.konpro.ai/v1/webhook/endpoint.update

Modify the configuration of an existing webhook endpoint by updating its URL and/or the list of subscribed events.

Request History

TIME	STATUS	USER AGENT
Make a request to see history.

0 Requests This Month

cURL Request

shell

curl --request PATCH \
--url https://api.konpro.ai/v1/webhook/endpoint.update \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
  "endpoint_id": "endpoint123",
  "url": "https://example.com/new-webhook-url",
  "events": ["video.updated", "avatar.deleted"]
}'

Request Body Parameters

Field	Type	Description
endpoint_id	string	Unique identifier of the webhook endpoint to update (required)
url	string	New callback URL to set for the endpoint. Must support SSL level 2 or higher if HTTPS
events	array[string]	Updated list of event types to listen for. Use None or empty array to subscribe to all events

Response

Response Structure

Field	Type	Description
endpoint_id	string	ID of the updated webhook endpoint
url	string	URL of the updated webhook endpoint
secret	string	Secret key for verifying callback authenticity
status	string	Current operational status of the webhook endpoint
events	array[string]	List of events the endpoint is currently subscribed to
username	string	Username associated with the webhook endpoint
created_at	datetime	Timestamp when the endpoint was originally created

Sample Response

json

{
  "endpoint_id": "webhook_123456",
  "url": "https://example.com/new-webhook-url",
  "secret": "whsec_abc123def456",
  "status": "enabled",
  "events": ["video.updated", "avatar.deleted"],
  "username": "user123",
  "created_at": "2024-01-15T10:30:00Z"
}

Notes

Requires API authentication.
Endpoint ID must exist and belong to the authenticated user.
URL must use HTTPS with SSL security level 2 or higher.
Events array can be empty to subscribe to all events.
Only provided fields will be updated.
Secret token remains unchanged during updates.
Endpoint status can be modified separately.
Refer to Error Responses for error information.

Example Usage

Shell

curl --request PATCH \
--url https://api.konpro.ai/v1/webhook/endpoint.update \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'x-api-key: <your-api-key>' \
--data '{
  "endpoint_id": "endpoint123",
  "url": "https://example.com/new-webhook-url",
  "events": ["video.updated", "avatar.deleted"]
}'

LANGUAGE

CREDENTIALS

Header

HEADER

RESPONSE

Examples

Choose an example:

application/json

200 - Success

400 - Bad Request

404 - Not Found

Add Webhook Endpoint Delete Webhook Endpoint