Portal Notices & Banners for Jira Service Management

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)

  1. In Jira, go to Settings → Apps → Portal Notices and choose Web trigger in the left column.
  2. Copy the Trigger URL.
  3. Choose Create token, then copy the token. It is shown only once; Portal Notices keeps just a fingerprint of it.
  4. Open the notice you want to control and tick Can be started and ended by the web trigger. Save it.
  5. 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>"}'

Jira automation

In Project settings → Automation, add the action Send web request:

  1. Web request URL: the trigger URL.
  2. HTTP method: POST.
  3. Web request body: Custom data, with {"action":"start","notice":"<notice ID>"}.
  4. Headers: add X-Portal-Notices-Token with your token, and Content-Type with application/json.
  5. 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

AnswerMeaning
200Done: the notice was started or ended.
403Refused.

A refusal is always the same plain 403, on purpose, so nobody can learn from it which notices exist. Check these, in order:

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