Invoke a Flow with an API endpoint

To access the settings on an API Endpoint card, click on the Endpoint settings icon on the bottom of the card.

You can invoke your Flow in one of two ways.

Exposed as a Webhook

To invoke a Flow as an exposed Webhook:

  1. In the API Endpoint Settings dialog, copy the URL that is in the Invoke URL field.
  2. Perform a GET/POST on that URL, depending on if you need to pass along data in the body of that request.
  3. If the client token is not appended to the URL that's in the Invoke URL field, pass along the client token as a query parameter.

Exposed as a Public Service

To invoke a Flow as a public service:

  1. In the API Endpoint Settings dialog, copy the URL that is in the Invoke URL field.
  2. Perform a GET/POST on that URL, depending on if you need to pass along data in the body of that request.

You don't need to pass along any other security measures in the request to invoke a Flow at this security level.

After you invoke the Flow, you'll receive output of your Flow as a response object.

Related topics

About invoking an API endpoint Flow