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:

In the terminal, navigate to the app directory and get the app's installation ID by running:
```
1
2
forge install list
```
Copy the Installation ID for the site and product you want the web trigger URL for.
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.
You'll be provided with a URL that you can use to invoke the web trigger. See webtrigger for more information about the forge webtrigger command.

By default, the URLs provided by forge webtrigger have no built-in authentication. As such, anyone can use the URL (and, by extension, invoke its related function) without providing an authentication token. You should keep these URLs secure.

Alternatively, you can also implement authentication inside the trigger itself. For example, you can add a check for an Authorization header in the request and validate any provided token.

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

Properties

Property Type Required Description

Property	Type	Required	Description
`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_-]+$`
`function`	`string`	Yes	A reference to the `function` module that defines the behavior.

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_-]+$

function string Yes A reference to the function module that defines the behavior.

The web trigger function's response requires a statusCode field. For information about web trigger request and response, see Web trigger events.

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