Proposal Editor Widget

Example editor widget with a text input field This webhook is queried to determine the appearance of the sidebar widget of draft proposals. It can be used to set custom values in the proposal’s data field. The layout is built up of a list of integration fields. The POST request will contain this in its body:

Content Details Request

{
  type: 'proposal.editorWidget';
  integration: IntegrationSessionData;
  proposal: Proposal;
}

The response needs to be in the following shape.

{
  data: {
    fields: IntegrationField[]
  }
}

Input fields will modify properties in the proposal’s data field. Proposales calls this webhook once per proposal while the editor stays open, with the proposal’s uuid as the proposal_uuid query parameter. A widget answered for one proposal is never shown on another, so the fields can depend on the proposal in the request body. Changing a value, or moving around the sidebar, does not call the webhook again; reload the editor to fetch a fresh widget.

Get Started

Webhooks

Proposal Editor Widget

When the widget is fetched

​When the widget is fetched

When the widget is fetched