Extracta.ai
DashboardJoin Discord
  • extracta.ai
    • Introduction
    • Overview
  • API Reference
    • 🔓Authentication
    • 📁Supported File Types
  • Data Extraction - API
    • đŸ’ģAPI Endpoints - Data Extraction
      • 1. Create extraction
      • 2. View extraction
      • 3. Update extraction
      • 4. Delete extraction
      • 5. Upload Files
      • 6. Get results
    • Extraction Details
      • 🌎Supported Languages
      • âš™ī¸Options
      • 📋Fields
    • Polling vs Webhook
    • ❌Webhook (LEGACY)
    • 🆕Webhook
    • 🆕Webhook Event Types
    • đŸ•šī¸Postman Integration
  • Document Classification - API
    • đŸ’ģAPI Endpoints - Document Classification
      • 1. Create classification
      • 2. View classification
      • 3. Update classification
      • 4. Delete data
        • 4.1 Delete classification
        • 4.2 Delete batch
        • 4.3 Delete files
      • 5. Upload Files
      • 6. Get results
    • Classification Details
      • 📄Document Types
  • Documents
    • Custom Document
    • Resume / CV
    • Contract
    • Business Card
    • Email
    • Invoice
    • Receipt
    • Bank Statement
  • Support
    • 💁Tutorials
    • đŸŸĸAPI Status
  • Contact
    • 📧Contact Us
    • ❓FAQ
Powered by GitBook
On this page
  • 🔍 Current Feature: extraction
  • ✅ Available extraction Events
  • extraction.processed
  • extraction.edited
  • extraction.confirmed
  • extraction.failed
  • 🧠 Future-Proofing: Other Feature Namespaces

Was this helpful?

  1. Data Extraction - API

Webhook Event Types

Extracta.ai webhooks send an event field in the payload to indicate what type of action occurred in the system. The event name is a namespaced string, with the format:

<feature>.<action>

This makes the system modular and scalable, allowing multiple features (e.g., data extraction, document classification, etc.) to have their own distinct set of events without overlap.


🔍 Current Feature: extraction

All current webhook events are prefixed with extraction. because they relate to data extraction, which is the first core feature of Extracta.ai.


✅ Available extraction Events

extraction.processed

Description: Triggered when one or more files are successfully processed and data has been extracted. If you process multiple files in a single upload, this webhook will be triggered when all the files are processed.

Why it's useful: Initiate follow-up actions like storing results, analyzing data, or notifying stakeholders.


extraction.edited

Description: Fired when a user manually edits the extracted data in the Extracta.ai interface.

Why it's useful: Track user input, sync updates to downstream systems, or trigger quality checks.


extraction.confirmed

Description: Occurs when a user manually confirms the extracted data, indicating final approval.

Why it's useful: Use this as a signal to finalize workflows, store results permanently, or notify teams.


extraction.failed

Description: Sent when a file fails to process (e.g. due to corruption, unsupported format, or internal errors).

Why it's useful: Alert your team, retry processing, or prompt the user to upload a new version.


🧠 Future-Proofing: Other Feature Namespaces

As Extracta.ai grows, additional webhook namespaces will be introduced. For example:

classification.* (future)


By using namespaced events like extraction.processed, your application can easily distinguish between different types of events and scale accordingly as new features are added.

PreviousWebhookNextPostman Integration

Last updated 6 days ago

Was this helpful?

🆕