Instant triggers (webhooks) in ÃÛ¶¹ÊÓƵ Workfront Fusion
Many services provide webhooks to deliver instant notifications whenever a certain change occurs in the service. To process these notifications, we recommend that you use instant triggers. You can recognize these easily in ÃÛ¶¹ÊÓƵ Workfront Fusion because of their tag:
If the service does not provide webhooks, you need to use polling triggers to periodically poll the service.
For a video introduction to webhooks in Workfront Fusion, see:
Access requirements
You must have the following access to use the functionality in this article:
To find out what plan, license type, or access you have, contact your Workfront administrator.
For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.
View a webhook’s queue
All messages from incoming webhooks are stored in the webhook’s queue.
-
Click Webhooks in the menu on left.
-
Find the Webhook for which you want to view the queue.
-
Click the button with a truck icon and the number of received webhooks.
note note NOTE Incoming webhook data is always stored in the queue regardless of how you have set the option Data is confidential (described in The scenario settings panel in ÃÛ¶¹ÊÓƵ Workfront Fusion). As soon as the data is processed in a scenario, it is permanently deleted from the system.
Schedule instant triggers
If your scenario contains an instant trigger, you can schedule the scenario to run immediately:
In this case your scenario will run immediately when Workfront Fusion receives new data from the service. After the scenario executes, the total amount of pending webhooks waiting in the queue is counted and the scenario performs as many cycles as there are pending webhooks, processing one webhook per cycle. For more information, see Scenario execution, cycles, and phases in ÃÛ¶¹ÊÓƵ Workfront Fusion.
-
A cycle is not the same as a scenario run. There can be multiple cycles within 1 scenario run.
-
When you execute a scenario with an instant trigger scheduled to be immediate, the following exceptions apply:
-
The interval between two executions is not subject to the Minimum interval according to the pricing plan.
For example, once the scenario finishes its execution, the webhook’s queue is checked again. If there are any pending webhooks, the scenario executes immediately again, processing all the pending webhooks once again.
-
The Maximum number of cycles scenario setting is ignored and set to 100, which means that no more than 100 pending webhooks will be processed during a single scenario execution (at the rate of 1 event per one cycle).
-
If you use any other schedule setting than Immediately, the scenario executes at the intervals you specify. As several webhooks can be gathered in the queue during the interval, it is recommended to set the Maximum number of cycles to a higher value than the default 1 to process more webhooks in one scenario run:
- Click the Scenario settings icon
- In the Scenario settings box that appears, type a number in the Max number of cycles box to indicate the number of webhooks from the queue that you want to run each time you execute the scenario.
Rate limits
The current rate limit is 5 webhooks per second. If the limit is exceeded, a 429 status code is returned.
Expiration of inactive webhooks
A webhook that has not been assigned to any scenario for more than 120 hours is removed.
Webhook payloads
Workfront Fusion stores webhook payloads for 30 days. Accessing a webhook payload more than 30 days after it was created results in the error “Failed to read file from storage.â€
Error handling
When there is an error in your scenario with an instant trigger, the scenario:
- Stops immediately - when the scenario is set to run Immediately.
- Stops after 3 unsuccessful attempts (3 errors) - when the scenario is set to run as scheduled.
If an error occurs during the scenario execution, the webhook is placed back into the queue during the instant trigger’s rollback phase. In such a situation, you have the possibility to fix the scenario and rerun it again. For more information, see Rollback in the article Scenario execution, cycles, and phases in ÃÛ¶¹ÊÓƵ Workfront Fusion.
If there is a Webhook response module in your scenario, the error is sent to the Webhook response. The Webhook response module is always executed last (in the case where the Auto commit option in the Scenario settings is not enabled). For more information, see Responding to webhooks in the article Webhooks.
Custom webhooks
You can create your own webhooks. For more information, see Webhooks.
Webhook deactivation
Webhooks are deactivated automatically if either of the following applies:
- The webhook has not been connected to any scenario for more than 5 days
- The webhook is used only in inactive scenarios, which have been inactive for more than 30 days.
Deactivated webhooks are deleted and unregistered automatically if they are not connected to any scenarios and have been in deactivated status for over 30 days.