Resuming a paused Flow
Before pausing or resuming 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, resuming your Flow will go in one of three ways, depending on your security setting. Note, that for each one of them it will require that you pass along an execution ID. You can grab this from execution history, or under the “context” object returned when invoking a Flow.
From most secure to least secure, you will resume a Flow like so:
- Exposed as a Secure Endpoint
- Take the URL provided on the API Settings page under “Resume URL”, and perform a GET/POST on that URL depending on if you need to pass along data in the body. Note, this URL also requires an execution ID, which you will need to replace in the URL you’ve copied from the API Settings panel.
- 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 “Resume URL”, and perform a GET/POST on that URL depending on if you need to pass along data in the body. Note, this URL also requires an execution ID, which you will need to replace in the URL you’ve copied from the API Settings panel.
- 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 “Resume URL”, and perform a GET/POST on that URL depending on if you need to pass along data in the body. Note, this URL also requires an execution ID, which you will need to replace in the URL you’ve copied from the API Settings panel
Upon resuming the Flow, you will receive back the final output of your Flow as the response. Additionally, the rest of the Flow will run as normal (all side-effects will occur) when resumed.