Skip to main content
GET
/
v1
/
webhooks
/
{webhook_config_id}
Get webhook configuration
curl --request GET \
  --url http://localhost:8000/v1/webhooks/{webhook_config_id} \
  --header 'Authorization: Bearer <token>'
{
  "webhook_config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "is_active": true,
  "retry_enabled": true,
  "max_retries": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Path Parameters

​
webhook_config_id
string<uuid>
required

Webhook configuration ID

Response

Webhook configuration details (without secret)

Webhook configuration response (without signing secret).

Used for list operations and updates where the secret is not returned.

Available Events: - document.uploaded: Document successfully uploaded and queued - document.processing.completed: Extraction completed successfully - document.processing.failed: Extraction failed with error

​
webhook_config_id
string<uuid>
required

Unique webhook configuration identifier

​
url
string
required

HTTPS webhook endpoint URL

​
events
string[]
required

List of event types subscribed to

​
is_active
boolean
required

Whether the webhook is active

​
retry_enabled
boolean
required

Whether to retry failed deliveries

​
max_retries
integer
required

Maximum retry attempts

​
created_at
string<date-time>
required

Configuration creation timestamp (ISO 8601)

​
updated_at
string<date-time>
required

Last modification timestamp (ISO 8601)