---
title: "document_uploaded"
method: POST
path: "document_uploaded"
tags: ["Webhooks"]
---

# document_uploaded

`POST document_uploaded` (webhook)

A document was uploaded. Use `id` with `GET /documents/get_download_link` to fetch the file.

## Payload

- object
  - `id` integer: Extracted document id. Pass this to `GET /documents/get_download_link`.
  - `uploader_email` string, nullable
  - `uploader_name` string, nullable
  - `client_email` string, nullable
  - `client_name` string, nullable
  - `entity_type` string, nullable
  - `client_phone` string, nullable
  - `client_timezone` string, nullable
  - `entity_id` integer
  - `entity_name` string, nullable
  - `external_entity_id` string, nullable
  - `entity_tags` EntityTag[]: Tags as objects.
    - `id` integer
    - `name` string
  - `firm_role_summary` string: A formatted, human-readable summary of who holds which role on the entity, not structured data. Empty when no roles are assigned. Use `GET /entities/{entity_id}/firm_role_assignments` if you need the underlying ids.
  - `document_name` string, nullable
  - `path` string, nullable
  - `link` string, nullable: Path within the Soraban app, relative to the firm's subdomain.
  - `meta_data` object
    - `questionnaire_id` integer, nullable
    - `year` integer, nullable
    - `assigned_to` string, nullable
    - `assigned_to_email` string, nullable

## Acknowledgement `200`

Return any 2xx to acknowledge. Returning `410 Gone` deletes the subscription.

---

[API](https://skmtc.dev/soraban/apis/soraban-private-api.md) - [All operations](https://skmtc.dev/soraban/apis/soraban-private-api/llms.txt) - [OpenAPI document](https://skmtc.dev/soraban/apis/soraban-private-api/revisions/1c230fa547ad?raw)