Add a "Powered By Estuary" workflow into the UI

[travjenkins]

Last Updated: Feb. 24, 2025

---

Businesses that operate a platform of their own can desire a seamless, customized integration of third-party applications, creating the impression that the customer is not leaving their environment. Therefore, a streamlined create workflow accessed via a user-defined URL should be offered.

Below are the base requirements for this feature: (TBD)

• Create a streamlined create workflow with the following steps:

  1. Select a connector from a compact grid view (when applicable).

  2. Configure the desired endpoint. No additional configuration information will be presented in this workflow. The catalog name will be the customer ID (which can be found in the URL) and the standard, post-fixed connector identifier (e.g., source-hello-world). All discoverable/associated bindings are attached with their default configuration as they are entirely hidden.

  3. Save and publish the task. The existing publication modal and error handling is a sufficient UX to provide insight into the publication process.

  4. Redirect the user using the user-specified, redirect URL associated with the workflow entry point.

• Add a new tab to the Admin page called Streamed by that enables the configuration of a shareable URL that serves as the entry point to this streamlined workflow. URL constraints are as follows:

  • A URL is scoped by tenant and data-plane by default. A different URL should be generated for each tenant to which the user has access. While tenants can be selected programmatically, the user must always specify the data-plane to which a URL applies.

  • A URL may be scoped by a connector. This should be handled in a similar fashion as the target tenant and data-plane. If a connector is specified, the streamlined workflow will skip the connector selection step.

  • A URL consists of two, required query parameters: a redirect URL and a customer ID. The redirect URL is where the user should be redirected upon successful completion of the workflow.

Design

Last Updated: Feb. 24, 2025

Pending. Wire-frames are underway.

Dependencies

Last Updated: Feb. 24, 2025

• Database support. A description of the dependency.

Additional Comments

• Notes about connector options in this workflow:

  • Customization of the list of connectors shown in this workflow should be supported. It will likely be a subset of the connector offerings.

  • The connector grid view should be much more compact in this workflow.

• Notes about endpoint configuration in this workflow:

  • Only the endpoint configuration form should appear in this workflow and there should not be a section header.

  • If another task exists for a given customer ID, we should provide a means for the user to re-authenticate if they would like to.

• While in this flow the user should not be able to see any other page.

• Future adaptations of this feature include:

  • Enable the customization of the appearance of the workflow by altering the background color and replacing the Estuary logo.

  • The Estuary logo and the text Streamed by Estuary should always appear in the bottom-right corner of the view.

References

Requirements

• PRD. A high-level outline of the current requirements and a glimpse of its next iteration. This document was shared on Feb. 21, 2025.

[travjenkins]

Starting to research this

[kiahna-tucker]

Questions

1. Can there only be a single, workflow entry point URL for a given combination of tenant, data-plane, and connector (when applicable)?

2. How should workflow entry point URLs be managed? Are these URLs valid for a specific period of time, requiring manual (token?) renewal to avoid invalidation? Or are these URLs valid indefinitely, requiring manual invalidation?

3. Should the computed catalog name be presented at some point in the workflow for reference? If so, where should it be located? I only ask as it may be useful to have a reference to the name, albeit, de-emphasized.

4. Should the user be automatically redirected when a publication succeeds or when after they have interacted with a CTA in the publication modal?

5. What information should be shown on the new, Streamed by tab on the Admin page? Is the purpose of this tab simply to enable the configuration of new, workflow entry point URLs? Or should existing, workflow entry point URLs be represented here in some fashion? If the latter, what information needs to be exposed about the existing URLs? Do they need to be able to be copied?

6. Should endpoint documentation be made available when viewing the form in this workflow? If so, how should that be accomplished (i.e., button that opens the documentation in a new tab or an embedded view like the side panel)?

Comments

• I would advise against passing the redirect URL as a query parameter. While I am unsure what form the backend architecture will take at this time, I could see this data being propagated via a directive.

[dyaffe]

Can we talk through these questions at UI/UX @kiahna-tucker? Some (debatable) thoughts are:

1. I think so, yes.
2. Maybe the easiest way would be to (a) format them in a way that would be guessable and (b) have the UI link to them automatically from each logo
3. I don't think so (but also debatable)
4. Yes

[kiahna-tucker]

Most definitely! I am using this issue as a notepad of sorts for questions and comments related to the feature for visibility and to track its evolution.