Webhooks

document_exported

A document was exported to tax software.

postWebhookdocument_exported

Payload

idinteger

Extracted document id.

file_typestring nullable
document_namestring nullable
pathstring nullable
exporter_emailstring nullable
exporter_namestring nullable
client_emailstring nullable
client_namestring nullable
external_client_idstring nullable
entity_namestring nullable
external_entity_idstring nullable
entity_typestring nullable
entity_idinteger
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.