SmartDocumentor
  • Overview
    • SmartDocumentor
  • GETTING STARTED
    • About SmartDocumentor
    • How SmartDocumentor Works
    • Main concepts
      • Workspaces
      • Organization
    • Quickstart 101
    • Licenses
      • How to Buy?
      • Support
    • Privacy
    • Security
  • Technical
    • Initial Setup
    • Mappings
    • API Reference
      • [POST] Client Credentials Access Token
      • [GET] Task Status
      • [GET] Task Status List
      • [GET] Task Status List Paginated
      • [GET] Get Workspaces
      • [PATCH] Reprocess Task
      • [POST] Create Task
      • [POST] Create Batch
      • [GET] Get Batch
      • [GET] Get Batch Paginated
      • Transcripts
        • Speakers
          • Workspaces
            • [GET] Workspace Speakers
            • [PUT] Workspace Speakers
          • Tasks
            • [GET] Task Speakers
            • [POST] Task Speaker
            • [PUT] Task Speaker
            • [DELETE] Task Speaker
      • Invite Users
        • [GET] List Available Roles
        • Tenants
          • [GET] List All Tenant Users
          • [POST] Invite Users
        • Workspaces
          • [GET] List All Workspace Users
          • [POST] Invite Users
    • Folder Worker
    • Export
      • Webhooks
        • Webhook (Text Documents)
        • Webhook (Transcripts)
        • Webhook Url To File (Transcripts)
        • Webhook Url to File (Anonymization)
    • Changelog
  • FAQs
    • FAQs
Powered by GitBook
On this page
  1. Technical
  2. Export

Webhooks

PreviousExportNextWebhook (Text Documents)

Last updated 3 months ago

SmartDocumentor has, by default, a generic integration mechanism that is suitable for most of the integrations required by customers, called Webhooks.

Webhooks follow to allow applications to push headless notifications to other applications.

SmartDocumentor allows sending such webhook notifications to a server of your choice. Webhooks are sent when a document is reviewed by an user or through automatic reviewal.

All webhook notifications are sent as HTTP POST requests, with a JSON request body containing important information for that particular export type and workspace.

Each workspace has one or more webhook export configurations, depending on the kinds of artifacts that can be exported.

Handling webhook notifications

If your server responds with a 2XX status, such as 200 or 204:

  • SmartDocumentor considers the notification was accepted and archives the document. The document becomes available in the page.

If your server responds with an error status, such as 400 or 500:

  • SmartDocumentor considers that the notification was not successfully handled, and sets the document back to the "To Review" state. If your server responds with a non-empty response body, then that response is logged by SmartDocumentor and can be displayed by inspecting the document in the page.

well known web practices
Inbox - Archive
Inbox - To Review