Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
  • App Installations
  • Atlassian GraphQL
  • Confluence
  • Forge Context
  • Forge Dynamic Modules
  • Forge Events
  • Forge KVS
  • Forge LLM
  • Forge Object Store
  • Forge Proxy
  • Forge Realtime
  • Forge WebTriggers
  • Forge SQL
  • Jira
Platform
Forge / Reference / APIs for Forge Container services

Forge WebTriggers

Postman Collection
OpenAPI

APIs for creating, listing, and deleting Forge web trigger URLs.

POST

Create a web trigger URL

Creates a public invocation URL for the supplied web trigger module key.

Request

Request bodyapplication/json

key

string

Required
forceCreate

boolean

Responses

Web trigger URL created successfully

application/json

CreateWebTriggerUrlResponse

The created public web trigger invocation URL.

POST/forge/webtrigger/url
1 2 3 4 5 6 7 8 curl --request POST \ --url '{FORGE_EGRESS_PROXY_URL}/forge/webtrigger/url' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "key": "my-trigger", "forceCreate": true }'
200Response
1 2 3 { "url": "https://install-uuid.webtrigger.atlassian.app/public/webtrigger-url-uuid-789" }
DEL

Delete a web trigger URL

Deletes a web trigger URL using the complete public URL returned when it was created.

Request

Query parameters

url

string

Required

Responses

Web trigger URL deleted successfully

DEL/forge/webtrigger/url
1 2 curl --request DELETE \ --url '{FORGE_EGRESS_PROXY_URL}/forge/webtrigger/url?url=https%3A%2F%2Finstall-uuid.webtrigger.atlassian.app%2Fpublic%2Fwebtrigger-url-uuid-789'
GET

List web trigger URLs

Returns all web trigger URLs available to the app.

Request

This request has no parameters.

Responses

Web trigger URLs available to the app

application/json

array<WebTriggerUrlSummary>

Web trigger URLs available to the app.

GET/forge/webtrigger/urls
1 2 3 curl --request GET \ --url '{FORGE_EGRESS_PROXY_URL}/forge/webtrigger/urls' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 [ { "key": "my-trigger", "url": "https://install-uuid.webtrigger.atlassian.app/public/webtrigger-url-uuid-789" } ]

Rate this page: