SOsoraban
Webhooks

document_uploaded

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

postWebhookdocument_uploaded

Payload

idinteger

Extracted document id. Pass this to GET /documents/get_download_link.

uploader_emailstring nullable
uploader_namestring nullable
client_emailstring nullable
client_namestring nullable
entity_typestring nullable
client_phonestring nullable
client_timezonestring nullable
entity_idinteger
entity_namestring nullable
external_entity_idstring nullable
firm_role_summarystring

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_namestring nullable
pathstring nullable
linkstring nullable

Path within the Soraban app, relative to the firm's subdomain.

Example payload

{
  "firm_role_summary": "Partner: Jane Doe, Manager: John Smith"
}

Response

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

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.