Skip to main content

Webhook Payload Structure

Each webhook delivers a complete and structured payload with all relevant task information, eliminating the need for additional API calls.

Complete Payload Example

{
  "id": "unique-webhook-id",
  "event": "task.completed",
  "timestamp": "2025-10-16T12:00:00Z",
  "task": {
    "id": "task-uuid",
    "title": "Contract Analysis",
    "description": "Review of contractual clauses",
    "status": "completed",
    "reference": 1234,
    // ... complete task metadata
  },
  "inputContent": {
    "files": [
      {
        "filename": "contract.pdf",
        "content": "processed and extracted content",
        "type": "application/pdf"
      }
    ]
  },
  "outputContent": "Complete analysis with all identified clauses..."
}

Field Reference

id
string
required
Unique notification identifier (useful for deduplication)
event
string
required
Which event triggered this webhook. Possible values:
  • task.completed - Task completed and ready for review
  • task.approved - Task approved
timestamp
string
required
Exact moment when the event occurred (ISO 8601 format)
task
object
required
Complete task data including:
  • id (string) - Unique task identifier
  • title (string) - Task title
  • description (string) - Task description
  • status (string) - Current task status
  • reference (number) - Readable task reference number
  • Additional metadata
inputContent
object
All input content that was processed:
  • files (array) - Array of processed files with:
    • filename (string) - Original file name
    • content (string) - Processed and extracted content
    • type (string) - File MIME type
  • Additional input data
outputContent
string
The complete result generated by the task

Next Steps

Overview

Learn about Events and webhooks

Configuration

Configure webhooks in your app

Authentication

Secure your webhook integrations