Invoke an API endpoint flow

An API Endpoint flow is a type of flow that can be triggered by changes at an external source.

Unlike flows that start with events associated with a connected application, these flows can be triggered at any time. The only requirement is that the external client calls the designated endpoint with the valid security credentials.

When the external client calls the endpoint, the flow is executed and the client receives any output from that flow execution.

There are two ways of exposing your API endpoint:

  • Exposed as a Webhook: An API endpoint flow that is exposed as a webhook is only accessible if the client making the HTTP request passes the proper client token to the invoke URL. The invoke URL is constructed using the flow alias. For more information about client tokens and flow aliases, see Flow client token and Flow aliases.
  • Exposed as a Public Service: An API endpoint flow that is exposed as a public service is available to anyone with the invoke URL. The invoke URL is constructed using the flow alias.

You can change how you expose an API endpoint using the API endpoint settings dialog. To access this dialog, click the Endpoint settings icon </> on the bottom of an API Endpoint event card.

Related topics

Resume a paused flow

Flow aliases

Flow client token