Start and end notices from outside
The web trigger lets another tool show or end a notice for you: a status page that reports an outage, a monitoring alert, a Jira automation rule, or a script. The notice appears or disappears on the portal on customers' next page view.
It can only start or end notices that you have allowed. It can't create, edit or delete anything, and it can't read your notices.
Set it up (Jira admins)
- In Jira, go to Settings → Apps → Portal Notices and choose Web trigger in the left column.
- Copy the Trigger URL.
- Choose Create token, then copy the token. It is shown only once; Portal Notices keeps just a fingerprint of it.
- Open the notice you want to control and tick Can be started and ended by the web trigger. Save it.
- Copy the notice's Notice ID from the same box. You send it with every call.
Call it
Send a POST to the trigger URL with your token in the X-Portal-Notices-Token header and a JSON body:
curl -X POST "<trigger URL>" \
-H "X-Portal-Notices-Token: <token>" \
-H "Content-Type: application/json" \
-d '{"action":"start","notice":"<notice ID>"}'
"action":"start"shows the notice from now on. A notice that was ended (or archived) comes back."action":"end"ends the notice now.
Jira automation
In Project settings → Automation, add the action Send web request:
- Web request URL: the trigger URL.
- HTTP method:
POST. - Web request body: Custom data, with
{"action":"start","notice":"<notice ID>"}. - Headers: add
X-Portal-Notices-Tokenwith your token, andContent-Typewithapplication/json. - Turn off Delay execution of subsequent rule actions until we've received a response if you don't need to wait.
Make a second rule (or a second action) with "action":"end" for when the incident is over. For example: *when an issue of type Incident moves to In Progress → start the outage notice; when it moves to Resolved → end it.*
Status pages and other webhooks
Any tool that can send an HTTP POST with a custom header and a JSON body works, for example a Grafana webhook contact point, an Uptime Kuma webhook notification or an Opsgenie webhook integration. Use the trigger URL, the POST method, the token header, and the body above.
Some status page services can't add a custom header to their webhooks. For those, send the webhook to a Jira automation rule with an Incoming webhook trigger and let the rule call the web trigger with Send web request, as above.
What the answer means
| Answer | Meaning |
|---|---|
| 200 | Done: the notice was started or ended. |
| 403 | Refused. |
A refusal is always the same plain 403, on purpose, so nobody can learn from it which notices exist. Check these, in order:
- The token is the current one (a replaced token stops working at once).
- The notice ID is right and the notice has Can be started and ended by the web trigger ticked.
actionis exactlystartorend, and the body is valid JSON under 2 KB.- You are under 30 calls per minute. Every call counts, including refused ones.
Replace the token
Choose Replace token under Web trigger and confirm. The old token stops working immediately, so update every tool that uses it. Do this whenever someone who knew the token leaves, or if it ends up somewhere it shouldn't.
If you lose the token, make a new one the same way: the app can't show an old one again.
Good to know
- Keep the token secret, like a password. Anyone with the token and a notice ID can start or end that notice.
- Only notices you ticked can be changed. A leaked token can't touch the others.
- Starting a notice sets Show from to now and clears an end date that has already passed. Ending one sets Until to now.
- The notice's last change is recorded as made by *web trigger*.