Common modules
Compass modules
Confluence modules
Jira modules
Jira Service Management modules

Rate this page:

Web trigger

The webtrigger module invokes a function as the result of an HTTP request.

Within your app, you can programatically obtain the URL to call the web trigger using the web trigger runtime API.

To manually obtain a web trigger URL for development purposes, perform the following steps:

  1. In the terminal, navigate to the app directory and get the app's installation ID by running:
    1
    2
    forge install:list
    
  2. Copy the Installation ID for the site and product you want the web trigger URL for.
  3. Get the web trigger URL by running:
    1
    2
    forge webtrigger
    
    1. Enter the installation ID you copied in step 2.
    2. Select the web trigger that you want the URL for. The options come from the manifest.

The URL displayed is your web trigger URL.

You can also schedule a web trigger to repeatedly invoke a function on a specific interval. See Scheduled trigger for more information.

Properties

PropertyTypeRequiredDescription
key

string

Yes

A key for the module, which other modules can refer to. Must be unique within the manifest.

Regex: ^[a-zA-Z0-9_-]+$

functionstringYesA reference to the function module that defines the behavior.

Example web trigger URL

1
2
https://4a6d16a1-bf25-4ddb-9a1a-3a781c11af3d.hello.atlassian-dev.net/x1/XUBR5WnG2Hk2V52APDdGaRSDm

Rate this page: