Beta
Webhook Configs

Create Webhook Config

Changed on

Create a reusable webhook configuration for the current project.

post/api/v1/beta/webhook-configs

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
  • Auth: HTTP bearer

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 required

URL to receive webhook POST notifications.

webhook_signing_secretstring nullable

Shared secret used to sign deliveries to this endpoint. Write-only: it is never returned in responses.

webhook_headersobject nullable

Custom HTTP headers sent with each webhook request.

webhook_eventsstring[] nullable

Events to subscribe to. If null, all events are delivered. An empty list subscribes to nothing and is rejected.

webhook_output_format'string' | 'json' nullable

Response format sent to the webhook: 'string' (default) or 'json'.

Example request

{
  "webhook_url": "https://example.com/webhooks/llamacloud",
  "webhook_signing_secret": "whsec_...",
  "webhook_headers": {
    "Authorization": "Bearer sk-..."
  },
  "webhook_events": [
    "parse.success",
    "parse.error"
  ],
  "webhook_output_format": "json"
}

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