[Discussion] Testing Wait for Webhook Action

[abuaboud]

Describe the Bug
We need to create an action that wait for webhook, this is useful and can be used in pieces like "Wait for Approval", in order to make this happen we need good testing experience.

Suggested Testing Experience:

Testing URL:
Display Webhook URL in markdown, allowing users to copy and test to generate sample data.

Production URL:
We can't generate one on the piece settings as it should be tied to flow run, so we need to include some information about the run and we can't do that unless we know the run information.

The reason we need the run id to know which flow run to resume.

Thus, we need a way for the user to have access to this URL. One solution is to have another action that outputs a URL similar to generating an approval URL. I believe we can have a more user-friendly UI.

All suggestions are welcome.

[abuaboud]

@rita-gorokhod @HoldYourWaffle

Your input is appreciated

[HoldYourWaffle]

If I understand correctly this'd basically be a more primitive variant of the existing "Wait for approval" piece.
One thing I've been missing in this area is a "timeout" branch to facilitate error handling or some form of retry mechanism.

Display Webhook URL in markdown

Would this test URL be flow-scoped and immutable?
Being able to reuse the same URL during testing would make things a lot more convenient 😍

I believe we can have a more user-friendly UI.

It's an interesting UX-design problem for sure...
I tried various arrangements of what such a control structure could look like, this is the best I've come up with so far:

This avoids two manually/implicitly coupled pieces, which makes mistakes less likely, is easier to teach, handles multiple approval steps in a flow without issue and is future-proof for a potential parallelization mechanic where multiple branches could be waiting at the same time.

In any case, informing/guiding the user is paramount, for example:

1. Documentation/tutorial page explaining how this mechanism works.
2. Warning during flow-building if the URL output of "Wait for" is not used within the "preparation" block.
3. Ideally this URL should not be accessible outside of the preparation block.

Curious what your thoughts are on this :)

[abuaboud]

@HoldYourWaffle

I dont think the url can be flow scoped, it has to be flow run scoped thats why we need two different url.

Now it's also get tricker when multiple approvals or waiting if they share same link that mean the same person on the first url can trigger the flow until the end not only their specific step.

This could be a security issue for approval piece.

So my suggestion goes to have a testing url when the user clicks test, it shows a url and instructions.

And user can use another step to generate url for the production purposes in one of the previous steps.