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

Field Reference

string
required
Unique notification identifier (useful for deduplication)
string
required
Which event triggered this webhook. Possible values:
  • task.completed - Task completed and ready for review
  • task.approved - Task approved
string
required
Exact moment when the event occurred (ISO 8601 format)
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
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
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