Invoking an API Endpoint Flow
Before invoking your Flow, make sure that the security settings are correct. For more information about setting security levels on an API Endpoint Flows, see “Learn more about API Endpoint Flows” below.
Once your security level is appropriately set, invoking your Flow will go in one of three ways, depending on your security setting. From most secure to least secure, you will invoke a Flow like so:
- Exposed as a Secure Endpoint
- Take the URL provided on the API Settings page under “Invoke URL”, and perform a GET/POST on that URL depending on if you need to pass along data in the body. Then, pass along the authentication headers listed in the Authentication section of the API documentation. If the security headings are properly generated, you should be able to invoke. You may also use the client to generate these authentication headers for you.
- Exposed as a Webhook
- Take the URL provided on the API Settings page under “Invoke URL”, and perform a GET/POST on that URL, depending on if you need to pass along data in the body of that request. The URL provided in that text box should already have the client token appended to the URL. If not, pass along the client token as a query parameter.
- Exposed as a Public Service
- Take the URL provided on the API Settings page under “Invoke URL”, and perform a GET/POST on that URL, depending on if you need to pass along data in the body of that request. Invoking a Flow at this security level does not require you to pass along any other security measures in the request.
Upon invoking the Flow, you will receive back the final output of your Flow as the response. Additionally, the Flow will run as normal (all side-effects will occur) when invoked.