Deployments
Once you have your workflow built and are ready to begin processing records, you can deploy your workflow. A workflow can have many deployments. As you modify your workflow steps, update connector versions or update any configurations, you can create a new deployment of that workflow. Previous deployments can be stopped if they are no longer needed and are finished processing any records that are in progress.
Clicking the Deploy button on your workflow will begin the process of setting up and activating all steps necessary to begin processing data.
You will be presented with some options for your deployment such as Start Date, End Date, Scale and Deployment Variables if any are set. If you want to activate your deployment but don't want it to start processing records yet, set the Start Date to a future date. And if you expect all data to finish processing by a certain date, set the proper End Date. If the deployment should run indefinitely, leave those fields blank and simply select Save, Publish and Deploy.
Scale
Deployment scale allows us to accommodate workflows that are expected to have high volumes and process that data in a timely manner. In most cases, the default scale of 1 is sufficient. However, if you are expected high record volume (i.e. over 300k per day) and need those records to be processed quickly, set your scale to a higher number. Some suggestions for scale setting:
Number of Records per day | Scale |
< 200k | 1 |
200k - 300k | 2 |
300k-500k | 4 |
> 500k | 8 |
When it is ready to begin processing data, your Deployment status will say Running.
Processing data on active Deployments
Now that your workflow version has been deployed and the deployment is Active, it is ready to begin processing data. Depending on how your workflow is configured, it will begin processing records differently. Some common examples are HTTP Trigger, Deployment Start Trigger and Timer. Each workflow requires that the first step be a connector that either receives data (HTTP Trigger) or a connector that generates an empty record such as Deployment Start Trigger or Timer.
HTTP Trigger
HTTP Triggers are configured to expect a certain payload. That payload could come from another system that is pushing data to your endpoint, or it could come from a simple Postman request if you are manually triggering an action. Once your deployment is in Running state, you can go into your HTTP Trigger to see the Endpoint that can be used to push data to the workflow.
Proxies
If an external system is pushing data to your workflow, you will want to add a Proxy on your HTTP Trigger, which allows you to keep the endpoint consistent in the event that you later update the workflow and create a new deployment. Once the deployment is Running, open your HTTP Trigger and click Select Proxy. Existing proxies (if any exist) will be displayed, but if you need to create a new one, click New Proxy. Provide a short Name and Description (optional) for the proxy. Click Submit and you will see your new proxy displayed. Click on your proxy name and click Submit.
You will now see your Proxy URL in the Proxy field. Click the Copy icon to copy the full proxy URL and provide it to the system that will be sending data to the workflow.
Deployment Start Trigger
Deployment Start Trigger can be placed as the first step in a workflow and will result in a single record being produced as soon as the deployment is Running. Deployment Start triggers are often used to start a process that calls another system to get data and then loops within the workflow to continue getting new data on an ongoing basis.
Timer
Timer connectors can be used to perform repetitive actions in your workflow such as getting data on an Hourly, Daily or Weekly basis. The timer will generate an empty record that then triggers the next step(s) in the workflow to run. Timers can include a Frequency in which to generate a record, an offset (hours/minutes after 00:00:00 UTC) and an option to Run Immediately. If Run Immediately is selected, a single record will be generated as soon as the deployment is Running and then again at the Frequency and Offset that is defined. If Run Immediately is not selected, it will run at the Frequency and Offset defined.
Deployment versions
Once a workflow has been deployed, you will see the number of active deployments in the Deployment column when viewing the list of Workflows for your organization.
To go directly to the latest active deployment, click the icon under the Actions heading.
If there are multiple Active deployments, simply click on the number of deployments in the Deployments column. There, you will see a list of all current and past deployments for that workflow. To view any of these deployments, click on the date for the deployment. Once deployments are stopped, they immediately stop processing all records. Once a deployment has been stopped, it is subject to being deleted. Deleted deployments can still be viewed, but cannot process any data or be restarted.