Operational notices and the API
Tell the assistant about today: an outage, a maintenance window, a delayed supplier. Manually, or from your own tooling.
What this is. A short, temporary message the assistant takes into account and mentions to customers when it is relevant.
Why it matters. Instructions describe how things normally work. A notice describes today. During an incident, a notice stops the wave of duplicate tickets about something you already know is broken.
Agent Instructions
Setting a notice by hand
- 1Open the service desk project and click Agent Instructions in the project menu.
- 2Type the notice in Operational notice. State the fact and when it ends, for example: “The website is down for maintenance until 12 February, 14:00 UTC.”
- 3Set Auto-expire to the time it stops being true.
- 4Click Set prompt. Use Clear prompt to remove it earlier.
Setting notices from your own tools
If you already have a status page, a deployment pipeline or incident tooling, it can set and clear notices automatically. The app exposes a private URL, called a web trigger, protected by a token you generate.
AI Portal Chat
••• Helpcurl -X POST <endpoint> \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "action": "set", "projectKey": "SD", "prompt": "Website down until Feb 12 14:00", "expiresAt": "2026-02-12T14:00:00Z" }'curl -X POST <endpoint> \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "action": "get", "projectKey": "SD" }'curl -X POST <endpoint> \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "action": "delete", "projectKey": "SD" }'- 1Open the API tab and click Generate Token.
- 2Copy the token immediately and store it where you keep other secrets. It is shown once and cannot be displayed again.
- 3Copy the API Endpoint shown underneath. It is your site's web trigger URL.
- 4Call that endpoint with the token. Every operation is a
POSTto the same URL; what changes is theactionfield in the body. - 5Connect it to whatever already knows about your incidents: set the notice when the incident opens, delete it when it closes.
| `action` | What it does | Other fields |
|---|---|---|
set | Sets or replaces the notice for a project. | projectKey, prompt, optional expiresAt |
get | Returns the current notice. | projectKey |
delete | Removes the notice. | projectKey |
list | Lists the service desks the app can see, with their project keys. | none |
curl -X POST "<API Endpoint>" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"action": "set",
"projectKey": "SD",
"prompt": "Website down for maintenance until Feb 12 at 14:00 UTC",
"expiresAt": "2026-02-12T14:00:00Z"
}'curl -X POST "<API Endpoint>" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{ "action": "delete", "projectKey": "SD" }'SD or ITSD. The app resolves it to the service desk itself. Run the list action once if you are not sure which keys it can see.You do not need this feature to use the app. If nobody is going to automate it, skip it and set notices by hand.