SOsoraban
Webhooks

questionnaire_submitted

A client submitted a questionnaire. Carries the full answer tree.

Note that entity_name on this event is the entity's tax return name, which can differ from its display name.

postWebhookquestionnaire_submitted

Payload

idinteger
questionnaire_namestring nullable
questionnaire_due_datestring date nullable
is_open_itemboolean nullable
tax_yearinteger nullable
external_entity_idstring nullable
entity_idinteger
client_emailstring nullable
client_namestring nullable
client_first_namestring nullable
client_last_namestring nullable
entity_namestring nullable

The entity's tax return name, not its display name.

entity_typestring nullable
client_phonestring nullable
client_timezonestring 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.

linkstring uri nullable

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.