Gotify REST-API

Name: Gotify REST-API API
Brand: Gotify REST-API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsPush NotificationsapiKey,basic32 EndpointsREST

For Agents

Send push messages to a self-hosted Gotify server, manage application and client tokens, and configure plugins for personal or fleet alerting.

Quickstart

Get started with Gotify REST-API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"send a push notification"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Gotify REST-API API.

Send a push message to a specific application using an appToken

Create or rotate application tokens for a service or shell script

Create client tokens for receiving devices such as the Android app

List and delete delivered messages from the server backlog

Upload an application icon to brand notifications in the receiver UI

GET STARTED

Start building with Gotify REST-API API

Explore with Jentic

View OpenAPI Document

Use for: I want to push a notification to my phone from a cron job, Send a Gotify message with priority 8 from a CI pipeline, Create a new application token for a backup script, Delete read messages older than 7 days from the server

Not supported: Does not handle SMS, email, or hosted push delivery — use for self-hosted Gotify message delivery and server administration only.

Jentic publishes the only available OpenAPI document for Gotify REST-API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for Gotify REST-API, keeping it validated and agent-ready. Gotify is a self-hosted push notification server, and this REST API exposes 32 endpoints to send messages, manage applications and clients, configure plugins, and administer users. Two token types govern access: appTokens (used by senders such as scripts and services) and clientTokens (used by receivers such as the Android app). Tokens may travel in the X-Gotify-Key header, the token query parameter, or as a Bearer Authorization header.

Use Cases

Patterns agents use Gotify REST-API API for, with concrete tasks.

★ Self-Hosted Server and Job Alerts

Send push notifications from cron jobs, CI pipelines, or systemd units to a self-hosted Gotify server, then receive them on phone or desktop without depending on a third-party push provider. POST /message with an appToken and priority drives the alert; clientTokens authenticate the receiving devices.

POST /message with title 'Backup failed', message 'Daily backup exited with code 2', priority 8, using the appToken bound to the 'backups' application.

Application and Token Management

Provision a new appToken per service or script so the operator can rotate or revoke tokens individually without rebooting the whole alert pipeline. The /application endpoints create, update, and delete applications, while /client endpoints manage receiving devices. Icons can be uploaded per application for visual triage in the receiver UI.

Create a new application named 'home-assistant', capture the returned appToken, upload icon ha.png to /application/{id}/image, and store the token in the secret manager.

Plugin-Driven Workflows

Use Gotify plugins to extend the server with bridges (matrix, telegram, pushover) or transform messages in flight. The /plugin endpoints list installed plugins, enable or disable them per user, and accept configuration updates so workflows can be re-tuned without restarting the server.

Enable plugin id 3 ('telegram-bridge') for the current user, then PUT /plugin/3/config with the chat_id and bot_token configuration.

AI Agent Personal Alerts

An AI agent that monitors logs, prices, or feeds can push direct alerts to the operator's Gotify server. Through Jentic, the agent finds POST /message by intent and uses a vault-stored appToken, so a long-lived push key never appears in the agent's prompt or tool list.

When an agent monitor detects a price drop on watch_id 42, POST /message with priority 5 and title 'Price drop' to the 'watcher' application.

Key Endpoints

32 endpoints — jentic publishes the only available openapi specification for gotify rest-api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/message

Send a push message

GET

/message

List recent messages

POST

/application

Create an application (sender)

POST

/application/{id}/image

Upload an application icon

POST

/client

Create a client (receiver)

GET

/health

Check server health

GET

/plugin

List installed plugins

POST

/plugin/{id}/enable

Enable a plugin

POST

/message

Send a push message

GET

/message

List recent messages

POST

/application

Create an application (sender)

POST

/application/{id}/image

Upload an application icon

POST

/client

Create a client (receiver)

GET

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Gotify appTokens and clientTokens are stored encrypted in the Jentic vault (MAXsystem). Agents reference tokens by name and Jentic adds the X-Gotify-Key header at execution time, so long-lived push keys never enter the agent's prompt.

Intent-based discovery

Agents search by intent (e.g., 'send a push notification to my phone') and Jentic returns POST /message with input schema, so the agent does not need to read the Gotify reference docs.

Time to first call

Direct Gotify integration: a few hours for the basic message send. Through Jentic: under 15 minutes to send the first push from an agent.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Pushover

Hosted push notification service for individuals and teams

Choose Pushover when the user does not want to self-host and is happy with a paid hosted service that handles iOS and Android delivery.

Alternative

Pushbullet

Cross-device push and clipboard sharing

Pick Pushbullet when device-to-device push (clipboard, files) matters more than self-hosted control.

Alternative

Firebase Cloud Messaging

Google's hosted push platform for mobile and web at scale

Use FCM when delivering at consumer scale (millions of devices) where self-hosted Gotify is not the right architecture.

FAQs

Specific to using Gotify REST-API API through Jentic.

Why is there no official OpenAPI spec for Gotify REST-API?

Gotify does not publish an OpenAPI specification through a centralized catalogue. Jentic generates and maintains this spec so that AI agents and developers can call Gotify REST-API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Gotify REST-API use?

Two token types: appTokens for senders (scripts, services) and clientTokens for receivers (apps, browsers). Tokens travel in the X-Gotify-Key header, the token query parameter, or a Bearer Authorization header. Basic auth is also accepted, mainly for creating an initial clientToken. Jentic stores tokens in the encrypted vault.

How do I send a push notification with the Gotify REST-API?

POST /message with the appToken in X-Gotify-Key, supplying message, optional title, and optional priority (0 silent through 10 highest). The server distributes the message to all clientTokens registered with that user, and connected receivers see it instantly via WebSocket.

Can I rotate Gotify application tokens through the API?

Yes. Create a new application via POST /application to receive a fresh appToken, update senders to use the new token, then DELETE the old application. This pattern lets each script have its own scoped token without restarting the Gotify server.

How do I integrate the Gotify REST-API with an AI agent through Jentic?

Run pip install jentic, search 'send a push notification' to find POST /message, load the schema, and execute. Jentic injects the appToken header from the vault. Get started at https://app.jentic.com/sign-up.