Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/reductoai/reducto-python-sdk/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Webhooks allow you to receive real-time notifications when asynchronous document processing jobs are completed. The Reducto SDK supports both Svix-managed webhooks (recommended for production) and direct webhooks.

​
Webhook Configuration Portal

The easiest way to configure webhooks is through the webhook configuration portal: 
from reducto import Reducto

client = Reducto()

# Get the webhook configuration portal URL
portal_url = client.webhook.run()
print(f"Configure webhooks at: {portal_url}")
This returns a URL where you can manage your webhook endpoints through an intuitive interface.

​
Webhook Modes

Reducto supports three webhook modes:

​
1. Disabled (Default)

Webhooks are disabled by default: 
response = client.parse.run(
    input="https://pdfobject.com/pdf/sample.pdf",
    webhook={
        "mode": "disabled"
    }
)
Svix provides enterprise-grade webhook delivery with automatic retries, monitoring, and debugging. This is the recommended mode for production: 
response = client.parse.run(
    input="https://pdfobject.com/pdf/sample.pdf",
    webhook={
        "mode": "svix",
        "metadata": {
            "user_id": "12345",
            "document_type": "invoice"
        },
        "channels": ["production"]  # Optional: deliver to specific channels
    }
)

​
3. Direct Mode

For simple use cases, you can send webhooks directly to a URL: 
response = client.parse.run(
    input="https://pdfobject.com/pdf/sample.pdf",
    webhook={
        "mode": "direct",
        "url": "https://your-domain.com/webhook-endpoint",
        "metadata": {
            "job_id": "abc123"
        }
    }
)
Direct webhooks do not include automatic retries or delivery guarantees. Use Svix mode for production applications.

​
Webhook Payload

When a job completes, Reducto sends a POST request to your webhook URL with the following payload: 
{
  "job_id": "job_abc123",
  "status": "completed",
  "result": {
    // Full parse result object
  },
  "metadata": {
    // Your custom metadata
  }
}

​
Using Channels (Svix Mode)

Channels allow you to route webhooks to different endpoints based on environment or purpose: 
# Send to production channel
response = client.parse.run(
    input="document.pdf",
    webhook={
        "mode": "svix",
        "channels": ["production"]
    }
)

# Send to multiple channels
response = client.parse.run(
    input="document.pdf",
    webhook={
        "mode": "svix",
        "channels": ["production", "analytics"]
    }
)

# Omit channels to send to all configured endpoints
response = client.parse.run(
    input="document.pdf",
    webhook={
        "mode": "svix"
    }
)

​
Custom Metadata

Include custom metadata in webhook requests to help identify and route the response: 
response = client.parse.run(
    input="invoice.pdf",
    webhook={
        "mode": "svix",
        "metadata": {
            "user_id": "user_123",
            "organization_id": "org_456",
            "document_type": "invoice",
            "priority": "high"
        }
    }
)
The metadata will be included in the webhook request body, allowing you to route and process the webhook appropriately.

​
Async Usage

Webhook configuration works identically with the async client: 
import asyncio
from reducto import AsyncReducto

client = AsyncReducto()

async def main():
    # Get webhook portal
    portal_url = await client.webhook.run()
    print(f"Configure webhooks at: {portal_url}")
    
    # Submit job with webhook
    response = await client.parse.run(
        input="document.pdf",
        webhook={
            "mode": "svix",
            "metadata": {"async_job": True}
        }
    )

asyncio.run(main())

​
Webhook Security

When using Svix mode, webhook requests are signed with a secret key. You can verify the signature to ensure the webhook is authentic. See the Svix documentation for details on signature verification.

​
Best Practices

Svix mode provides automatic retries, delivery monitoring, and debugging tools that are essential for production applications.
Always include metadata that helps you identify and route the webhook response, such as user IDs, job IDs, or document types.
Your webhook endpoint should be idempotent, as you may receive the same webhook multiple times due to retries.
Your webhook endpoint should respond with a 2xx status code within a few seconds. Perform any heavy processing asynchronously.

Build docs developers (and LLMs) love

Get started for freeTalk to us