Invoking an API endpoint flow

API Endpoint flows are flows that can be triggered from an outside source. Unlike flows that start with events associated with an application, these flows can be triggered at any time, so long as the client is hitting the appropriate endpoint with the appropriate security setting.

The client calling the endpoint causes the flow to execute and the client receives back the output of that execution of the flow.

You can expose this API endpoint in two ways:

  • Exposed as a Webhook: A flow exposed at this security level will only be able to be accessed if the client making an invoke / resume / retry request is passing along the proper client token along with the proper invoke URL (which includes a flow alias). For more information about client tokens and flow aliases, see Flow client token and Flow aliases.
  • Exposed as a Public Service: A flow exposed at this security level will be available to anyone with the invoke URL. This invoke URL is built off of the flow alias.

You change how you want to expose an API endpoint from the API Endpoint Settings dialog.

Once you’ve decided how you want your API Endpoint to be properly exposed, you may then invoke the flow.

Related topics

Resume a paused flow

Flow aliases

Flow client token