Beta
Webhook Configs

Update Webhook Config

Changed on

Update a webhook configuration. Only fields present in the request change.

put/api/v1/beta/webhook-configs/{config_id}

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/beta/webhook-configs/{config_id}
  • Auth: HTTP bearer

Path parameters

config_idstring required

Query parameters

tenant_type'project' | 'project_default'

Which configurations to address: project for ones a job references by ID, or project_default for ones every job in the project notifies.

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

webhook_urlstring nullable

Updated webhook URL.

webhook_signing_secretstring nullable

Updated signing secret (write-only). Send to rotate the secret.

webhook_headersobject nullable

Updated headers.

webhook_eventsstring[] nullable

Updated event subscriptions. Omit to leave unchanged; [] is rejected.

webhook_output_format'string' | 'json' nullable

Updated output format.

Response

Successful Response

idstring required

Unique identifier for the webhook configuration.

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

tenant_type'project' | 'project_default' required

Owner tenant type.

tenant_idstring required

Owner tenant ID.

webhook_urlstring required

URL that receives webhook POST notifications.

has_secretboolean required

Whether a signing secret is configured for this endpoint.

webhook_headersobject nullable

Custom HTTP headers sent with each request.

webhook_eventsstring[] nullable

Subscribed events (null = all events).

webhook_output_format'string' | 'json' nullable

Response format sent to the webhook.

Changes