Gotify

App · 5 actions

Send push notifications to your phone with Gotify, your own notification server: titles, priorities, Markdown, links and images. List and clean up messages, and start a workflow when one arrives.

Actions

ActionWhat it does
Delete messageDelete one message from Gotify, by its ID.
Delete messagesClean up Gotify: delete an application's messages, or every application's, all of them or only those older than some days.
List applicationsList the applications in Gotify that messages are sent as, with their IDs and default priorities.
List messagesList the newest messages in Gotify, from every application or one, newest first.
Send notificationSend a push notification to the phones and browsers showing Gotify, with a title, a priority, Markdown, a link to open when it's tapped and a big image.

Delete message

Delete one message from Gotify, by its ID. Needs a client token on the connection.

Inputs

Message IDmessagetextRequired
The message's ID, as a step that sent or listed it gives.

Outputs

deletedtrue/false
True once it's deleted
idnumber
The deleted message's ID
Example output
{
  "deleted": true,
  "id": 128
}

Delete messages

Clean up Gotify: delete an application's messages, or every application's, all of them or only those older than some days. Needs a client token on the connection.

Inputs

ApplicationapplicationtextRequired
Whose messages to delete: one application, or Every application.
Older than (days)older_than_daysnumber
Only delete messages older than this many days, such as 30. Leave blank to delete them all.From 0 to 3650.

Outputs

applicationtext
The application's name, or Every application
application_idnumber
The application's ID; 0 for every application
deleted_countnumber
How many messages were deleted
has_moretrue/false
Whether old messages are left for another run
older_thantext
Messages sent before this time were deleted (ISO 8601, UTC); empty when all were
Example output
{
  "application": "Backups",
  "application_id": 3,
  "deleted_count": 12,
  "has_more": false,
  "older_than": "2026-10-07T02:06:37Z"
}

List applications

List the applications in Gotify that messages are sent as, with their IDs and default priorities. Needs a client token on the connection.

Inputs

None.

Outputs

applicationslist
The applications
countnumber
How many applications there are
Example output
{
  "applications": [
    {
      "created_at": "2026-11-01T09:00:00Z",
      "default_priority": 5,
      "description": "Nightly backups of the file server",
      "id": 3,
      "image_url": "https://gotify.example.com/static/defaultapp.png",
      "internal": false,
      "last_used": "2026-11-06T02:06:37Z",
      "name": "Backups"
    }
  ],
  "count": 1
}

List messages

List the newest messages in Gotify, from every application or one, newest first. Needs a client token on the connection.

Inputs

Applicationapplicationtext
Only this application's messages. Leave blank for every application.
How manylimitnumber
The most to list, newest first. Defaults to 25.From 1 to 500.

Outputs

countnumber
How many messages were listed
has_moretrue/false
Whether there are more than were listed
messageslist
The messages, newest first
Example output
{
  "count": 1,
  "has_more": false,
  "messages": [
    {
      "application": "Backups",
      "application_id": 3,
      "click_url": "https://backups.example.com/runs/42",
      "date": "2026-11-06T02:06:37Z",
      "extras": {
        "client::display": {
          "contentType": "text/markdown"
        },
        "client::notification": {
          "click": {
            "url": "https://backups.example.com/runs/42"
          }
        }
      },
      "id": 128,
      "image_url": "",
      "markdown": true,
      "message": "**Nightly backup** finished in 4 minutes.",
      "priority": 5,
      "priority_level": "Normal",
      "title": "Backup finished"
    }
  ]
}

Send notification

Send a push notification to the phones and browsers showing Gotify, with a title, a priority, Markdown, a link to open when it's tapped and a big image.

Inputs

MessagemessagetextRequired
What the notification says.
Titletitletext
Its title. Leave blank and Gotify uses the application's name.
Priorityprioritytext
How strongly phones get your attention. Leave blank for the application's default priority.One of: 0 (None: listed in Gotify, no notification (0)), 2 (Low: an icon, no sound (2)), 5 (Normal: with a sound (5)), 8 (High: sound and vibration (8)), 10 (Highest (10)).
Markdownmarkdowntrue/false
Show the message as Markdown: **bold**, lists, links and pictures.
Link to openclick_urltext
A link the Android app opens when the notification is tapped, instead of opening Gotify.
Big imageimage_urltext
A web link to a picture the Android app shows large in the notification.
Applicationapplicationtext
Send as this application. Leave blank to send as the one whose token the connection has; another one needs a client token on the connection.

Outputs

applicationtext
The application's name; empty when the connection has no client token
application_idnumber
The ID of the application it was sent as
click_urltext
The link opened when the notification is tapped; may be empty
datetext
When it was sent (ISO 8601, UTC)
extrasobject
Everything sent with it as Gotify extras, as sent
idnumber
The message's ID
image_urltext
The big image shown in the notification; may be empty
markdowntrue/false
Whether it is shown as Markdown
messagetext
What it says
prioritynumber
Its priority, usually 0 to 10
priority_leveltext
How the Android app shows it: None (no notification), Low (an icon), Normal (with a sound) or High (sound and vibration)
titletext
Its title; Gotify uses the application's name when none is given
Example output
{
  "application": "Backups",
  "application_id": 3,
  "click_url": "https://backups.example.com/runs/42",
  "date": "2026-11-06T02:06:37Z",
  "extras": {
    "client::display": {
      "contentType": "text/markdown"
    },
    "client::notification": {
      "click": {
        "url": "https://backups.example.com/runs/42"
      }
    }
  },
  "id": 128,
  "image_url": "",
  "markdown": true,
  "message": "**Nightly backup** finished in 4 minutes.",
  "priority": 5,
  "priority_level": "Normal",
  "title": "Backup finished"
}

On this page