SOsoraban
Webhooks

document_deleted

A document was deleted.

Note that entity_tags on this event is an array of tag names, not objects. Most other events send objects.

postWebhookdocument_deleted

Payload

deleter_emailstring nullable
deleter_namestring nullable
client_emailstring nullable
client_namestring nullable
entity_typestring nullable
client_phonestring nullable
client_timezonestring nullable
entity_namestring nullable
document_namestring nullable
pathstring nullable
external_entity_idstring nullable
entity_idinteger
entity_tagsstring[]

Tag names only. Used by document_deleted and questionnaire_comment_added; every other event sends objects.

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.

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.