Document alert tickets

README, INTEGRATIONS (the osTicket ticket API: fields, making the key, what is sent, what it can't do,
what wasn't verified), NOTIFICATIONS (the rules, in one table), ROLES, DATABASE (the new table, the
settings key, the internal flags, what deleting an integration does), and the Privacy page (the one new
thing that leaves the app: an alert's text, to your osTicket).

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
bobbanandClaude Sonnet 5.5 committed 2026-10-07 23:41:47 +02:00
1 parent 96c93ef924
commit aec553f122
5 files changed
+86 -8

No files matched your search

+21 -2
View File
@@ -116,8 +116,8 @@ the dashboard views themselves load fine.
reading osTicket's own MySQL/MariaDB database directly, the same way osTicket's own admin panel does internally.
This makes it the only integration in this app that isn't a REST API.
- **Actions used:** read-only — a single `SELECT` joining the ticket, status, priority, department, staff, team,
and requester tables for every ticket whose status is in the "open" state. Nothing here can create, update, or
close a ticket.
and requester tables for every ticket whose status is in the "open" state. Nothing in this part can create,
update, or close a ticket — opening tickets is the separate, optional API described below.
- **Required access:** a MySQL/MariaDB user with **read-only (`SELECT`) access to the osTicket database only** —
never reuse osTicket's own application database user, which has full read/write access. Create one with
something like:
@@ -148,6 +148,25 @@ the dashboard views themselves load fine.
a field looks wrong, tell us what happened and we'll adjust — this one has had less real-world exposure than
every other integration listed here.
**Optional: opening tickets for alerts** (Settings → Alert tickets)
- **Config fields:** Ticket API address (optional), Ticket API key (optional, stored encrypted like the database
password), Allow self-signed certificate (ticket API). Leave them empty and the integration works as before.
- **Auth:** osTicket's own HTTP API: `POST <address>/api/tickets.json` with the key in an `X-API-Key` header.
- **Make the key in osTicket:** Admin Panel → Manage → API Keys → Add. Tie it to the IP address osTicket sees this
app's requests come from (behind Docker or a reverse proxy that is the host's or proxy's address, not the
container's — check osTicket's log if it refuses) and tick **Can create tickets**. osTicket refuses a key from any
other address, which is the most common reason a test ticket fails.
- **What is sent:** one ticket per problem — name and email you set under Settings → Alert tickets, a subject, the
problem's text and a link back to this app, optionally a help topic and priority id — with `autorespond` off (the
"user" is this app, so an acknowledgement would only bounce) and osTicket's own staff alert on or off as you choose.
- **What it can't do:** close, reopen, or comment on a ticket — osTicket's API has no such endpoint. A ticket opened
here is yours to close in osTicket.
- **Not verified against a real osTicket** — built from osTicket's published API documentation and tested against a
stand-in server that checks what is sent (the key header, the JSON fields, the message encoding, and how each
answer — created, refused key, bad request, redirect — is handled). If osTicket rejects a ticket, "Send a test
ticket" shows the reason it gave.
### phpIPAM
- **Config fields:** phpIPAM URL, API app ID, App token