---
title: "Event"
method: POST
path: "event"
---

# Event

`POST event` (webhook)

When events occur in Ragie such as a document being processed, we'll send this data to URLs that you can register in app. Learn more about webhooks in our docs: https://docs.ragie.ai/docs/webhooks.

## Payload

- union
  - DocumentUpdateWebhook
    - `nonce` string, required
    - `type` 'document_status_updated', required
    - `payload` DocumentUpdateWebhookPayload, required
      - `document_id` string, required
      - `status` union, required
        - 'ready'
        - 'failed'
        - 'refined'
        - 'indexed'
        - 'keyword_indexed'
        - 'paused_insufficient_credits'
      - `partition` string, required
      - `metadata` object, required
      - `external_id` string, nullable, required
      - `name` string, required
      - `connection_id` string, nullable, required
      - `sync_id` string, nullable, required
      - `error` string, nullable, required
  - DocumentDeleteWebhook
    - `nonce` string, required
    - `type` 'document_deleted', required
    - `payload` DocumentDeleteWebhookPayload, required
      - `document_id` string, required
      - `partition` string, required
      - `metadata` object, required
      - `external_id` string, nullable, required
      - `name` string, required
      - `connection_id` string, nullable, required
      - `sync_id` string, nullable, required
  - EntityExtractedWebhook
    - `nonce` string, required
    - `type` 'entity_extracted', required
    - `payload` EntityExtractedWebhookPayload, required
      - `entity_id` string, required
      - `document_id` string, required
      - `instruction_id` string, required
      - `document_metadata` object, required
      - `document_external_id` string, nullable, required
      - `document_name` string, required
      - `partition` string, required
      - `sync_id` string, nullable, required
      - `data` object, required
  - ConnectionSyncStartedWebhook
    - `nonce` string, required
    - `type` 'connection_sync_started', required
    - `payload` ConnectionSyncStartedWebhookPayload, required
      - `connection_id` string, required
      - `sync_id` string, required
      - `partition` string, required
      - `connection_metadata` object, required
      - `create_count` integer, required
      - `update_content_count` integer, required
      - `update_metadata_count` integer, required
      - `delete_count` integer, required
  - ConnectionSyncProgressWebhook
    - `nonce` string, required
    - `type` 'connection_sync_progress', required
    - `payload` ConnectionSyncProgressWebhookPayload, required
      - `connection_id` string, required
      - `sync_id` string, required
      - `partition` string, required
      - `connection_metadata` object, required
      - `create_count` integer, required
      - `created_count` integer, required
      - `update_content_count` integer, required
      - `updated_content_count` integer, required
      - `update_metadata_count` integer, required
      - `updated_metadata_count` integer, required
      - `delete_count` integer, required
      - `deleted_count` integer, required
      - `errored_count` integer, required
      - `paused_insufficient_credits_count` integer, required
  - ConnectionSyncFinishedWebhook
    - `nonce` string, required
    - `type` 'connection_sync_finished', required
    - `payload` ConnectionSyncFinishedWebhookPayload, required
      - `connection_id` string, required
      - `sync_id` string, required
      - `partition` string, required
      - `connection_metadata` object, required
  - ConnectionLimitExceededWebhook
    - `nonce` string, required
    - `type` 'connection_limit_exceeded', required
    - `payload` ConnectionLimitExceededWebhookPayload, required
      - `connection_id` string, required
      - `partition` string, nullable, required
      - `connection_metadata` object, required
      - `limit_type` 'page_limit', required
  - PartitionLimitExceededWebhook
    - `nonce` string, required
    - `type` 'partition_limit_exceeded', required
    - `payload` PartitionLimitExceededWebhookPayload, required
      - `partition` string, required
      - `limit_type` 'pages_processed_limit_monthly' | 'pages_hosted_limit_monthly' | 'pages_processed_limit_max' | 'pages_hosted_limit_max' | 'video_processed_limit_monthly' | 'video_processed_limit_max' | 'audio_processed_limit_monthly' | 'audio_processed_limit_max' | 'media_streamed_limit_monthly' | 'media_streamed_limit_max' | 'media_hosted_limit_monthly' | 'media_hosted_limit_max', required
  - PartitionLimitResetWebhook
    - `nonce` string, required
    - `type` 'partition_limit_reset', required
    - `payload` PartitionLimitResetWebhookPayload, required
      - `partition` string, required

## Acknowledgement `200`

Successful Response

- unknown

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/ragie/apis/ragie-api.md) · [All operations](https://skmtc.dev/ragie/apis/ragie-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ragie/ragie-api/revisions/ffdf960539ca/schema)