ConceptFor engineers

Build your own UI

Build a custom interface on Awell's API when neither Hosted Pages nor Navi gives enough control.

A custom interface on top of the Orchestration API gives full control of every pixel and interaction, and means owning every edge case.

Before choosing it, be clear about what the other options already handle:

  • Hosted Pages already handles accessibility, internationalization, responsive layout, keyboard navigation and form auto-save, all of which take real work to rebuild well.
  • Navi renders activities inside the host product, with the organization's branding, while Awell maintains the activity rendering and its edge cases.

Build a custom UI for something genuinely different: an interaction model neither supports, or a surface such as a kiosk or a native component that has to be first-party.

Everything a UI needs is in the Orchestration API

The API covers reading pending activities, submitting form responses and completing activities. See the API reference.

The activity model and lifecycle is worth reading even without Navi, because it describes the states a custom UI has to handle.

Next steps

Next: What is Navi?, often the middle ground between a custom UI and Hosted Pages.

On this page