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

# questionnaire_submitted

`POST questionnaire_submitted` (webhook)

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.

## Payload

- object
  - `id` integer
  - `questionnaire_name` string, nullable
  - `questionnaire_due_date` string, date, nullable
  - `is_open_item` boolean, nullable
  - `tax_year` integer, nullable
  - `external_entity_id` string, nullable
  - `entity_id` integer
  - `entity_tags` EntityTag[]: Tags as objects.
    - `id` integer
    - `name` string
  - `client_email` string, nullable
  - `client_name` string, nullable
  - `client_first_name` string, nullable
  - `client_last_name` string, nullable
  - `entity_name` string, nullable: The entity's tax return name, not its display name.
  - `entity_type` string, nullable
  - `client_phone` string, nullable
  - `client_timezone` string, nullable
  - `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.
  - `link` string, uri, nullable
  - `advisors` object[]
    - `name` string, nullable
    - `email` string, nullable
  - `uploaded_documents` object[]
    - `id` integer
    - `path` string, nullable
  - `sections_with_questions` object[]: The questionnaire's sections, each with its questions, answers, comments, and follow-ups.
    - `id` integer
    - `name` string, nullable
    - `type` string, nullable
    - `marked_completed` boolean, nullable
    - `template_section_id` integer, nullable
    - `questions` object[]
      - `id` integer
      - `text` string, nullable
      - `template_question_id` integer, nullable
      - `answer` string, nullable
      - `answer_by` string, nullable
      - `optional` boolean, nullable
      - `questionnaire_comments` object[]
      - `follow_up_questions` object[]

## 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)