Skip to main content

Web Triggers

Compatibility

This module is available for both the Jira and Confluence versions of the app.

Web Triggers are JavaScript functions running on the Forge back end that respond to HTTP requests. They enable seamless integration between your Jira or Confluence instances and external systems without requiring user authentication.

In Script Master, Web Triggers serve as an extension of Forge Web Trigger.

Setting Up Web Triggers​

  1. Go to the Web Triggers tab from the Script Master page.
  2. Create a new web trigger by writing a JavaScript function.
  3. Save the web trigger to generate a unique URL.
  4. Use this URL to handle HTTP requests.

We are using a powerful code editor, which will assist you in writing code more efficiently. Read more about Code Editor features, shortcuts, and more.

Context​

Web Triggers implement Forge backend FaaS function, allowing you to utilize all Bridge API for Forge backend FaaS function. Among the most useful are api and request.

Best Practices​

  • Security Considerations: Validate incoming requests and perform authorized actions within Jira or Confluence applications to ensure security.
  • Error Handling: Implement robust error handling to ensure reliable trigger operation.
  • Performance Optimization: Optimize trigger performance for minimal latency and improved responsiveness.

Limitations​

Maximum Number of Web Triggers

Script Master enforces a limit of 20 web triggers per instance. When this limit is reached, administrators will see a warning and won't be able to create additional triggers.

The 20-trigger limit is designed to cover most integration scenarios while maintaining optimal performance. Keep in mind:

  • No pagination: Since the maximum is 20 triggers, all triggers are displayed on a single page.
  • Search functionality: The search feature filters within the existing 20 triggers for quick access.
  • Design for flexibility: A single web trigger can handle multiple scenarios by:
    • Returning different responses based on input parameters
    • Supporting different HTTP methods (GET, POST, PUT, etc.) within the same trigger
    • Implementing conditional logic to serve various use cases

If you approach this limit, consider consolidating triggers by leveraging parameter-based routing or method-based handling within your trigger scripts.

Key Features​

  • No User Authentication Required: Accessible via a unique URL, allowing external systems to communicate with Jira or Confluence seamlessly.
  • Communication with Jira: Interact with application using the useApp() method, enabling actions such as issue creation, updates, and workflow triggers.
  • Scalability and Reliability: Benefit from Forge platform's scalability and reliability for handling a large volume of requests.

Use Cases​

  • Integrating with External Systems: Integrate Jira or Confluence with third-party applications or internal tools for seamless data synchronization.
  • Automating Workflows: Trigger actions based on specific events or conditions to streamline processes and improve productivity.
  • Extending Functionality: Enhance functionality of Jira or Confluence with custom actions or behaviors to meet organizational needs.

Examples​

  • Authorization. Example of adding a check for an "authorization" header in the request and validate any provided token.