Links

Links are used to create entry point URLs to web flows, so they can be accessed by users. Web flows without a configured link is not accessible outside the flow editor.

Comparison to webhooks

Links works similarly to webhooks in that:

• URLs are created in the same manner
• URLS are available on the server’s inbound HTTP server, if configured
• Flow input data has the same structure, properties and metadata

Links are different from webhooks in that:

• Links are used with web flows only
• Links do not have authentication
• Link URLs should be accessed by a browser

Configuring links

Before creating a link, you should have an existing web flow to associate with it.

1. In the UI, navigate to Links, under Flows in the menu

2. Click on the New Link button

3. Optionally, change the default link identifier, and select the target web flow

   

After saving the link, it appears like this in the link list:

When opening the link’s URL, the browser should open the web flow in a new tab:

Tip

The target web flow can be changed on any existing link.

How links work

When a browser accesses a link’s URL, Sirveo serves a light-weight web app, which is the client UI that handles interactions between users and web flows.

The flow input for a web flow has the same structure which is used for flows that are run via webhooks. This means that the client IP address, query parameters and request headers are available for use in the flow. However, the input request body for web flows is considered an implementation detail of a particular Sirveo release.

As such, it is not recommended to directly use the data in the request body of web flow input. Changes to the implementation are not considered breaking changes. Instead, the $web store is available in web flows as a stable feature.