This is for general information. Workflows that are triggered via external sources currently do not capture details about which external system initiated the trigger.
Would it be a good approach to define a mandatory field to record the external trigger details wherever an external trigger is used?
While reviewing the workflows, I noticed that many workflows have external triggers configured but do not contain any information about the calling external system.
Hi anibran Fire and Forget: It is a one-way communication to notify subscribers. It only sends request to subscribers and don’t wait responses from subscribers.
Response Required Trigger: It is a two-way communication between the trigger service and subscriber. It sends request to subscribers and wait responses from subscribers.
You’ve identified an excellent point regarding external trigger documentation in workflows! This is indeed a common challenge when managing workflows at scale.
Current State
You’re correct that the workflow external trigger configuration itself doesn’t enforce capturing information about the calling external system. When you create an external trigger, the API provides:
A unique callback URL
OAuth client credentials (client ID and client secret)
The trigger name and description
However, there’s no mandatory field that documents which specific external system will use these credentials.
Recommended Approach
Here are some best practices to address this:
1. Use Descriptive Names and Descriptions
When creating or updating workflows with external triggers, leverage the name and description fields strategically:
2.Implement a Documentation Standard
Create a governance policy that requires:
Trigger name should include the source system name
Description should document:
External system name and environment
Integration owner/contact
Purpose of the integration
Any relevant ticket/change request numbers
3. Use Workflow Variables or Comments
Add a comment step at the beginning of workflows with external triggers that documents the integration.
4. Maintain an External Registry
Consider maintaining a separate configuration management database (CMDB) or documentation system that maps: