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:
- In the API Endpoint Settings dialog, copy the URL that is in the Invoke URL field.
- Perform a GET/POST on that URL, depending on if you need to pass along data in the body of that request.
- Authenticate your request by using one of the following methods:
- Pass the provided token using the clientToken query parameter. This is the default behavior.
- Pass the provided token as the value for the x-api-client-token header. This is the most secure option; do not use it in conjunction with the clientToken query parameter.
Exposed as a Public Service
To invoke a flow as a public service:
- In the API Endpoint Settings dialog, copy the URL that is in the Invoke URL field.
- 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.