SOsoraban
Webhooks

questionnaire_created

A questionnaire was created.

This event carries no questionnaire id. Match on entity_id plus tax_year plus template_name, or use questionnaire_locked / questionnaire_updated, which do carry id.

postWebhookquestionnaire_created

Payload

template_namestring

The questionnaire's name, taken from the template.

tax_yearinteger nullable
external_entity_idstring nullable
entity_idinteger
client_emailstring nullable
client_namestring nullable
entity_namestring nullable
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.

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.