ByteChef LogoByteChef
Components

Gotify

A simple server for sending and receiving messages.

Categories: Communication

Type: gotify/v1


Connections

Version: 1

Bearer Token

Properties

NameLabelTypeDescriptionRequired
tokenTokenSTRINGApplication token of the app you created for receiving and sending messages.true
baseUriBase URISTRINGBase URI of your Gotify server (e.g. http://localhost:1024).true

Actions

Send Message

Name: sendMessage

Sends a message to the server.

Properties

NameLabelTypeDescriptionRequired
titleMessage TitleSTRINGThe title of the message that will be sent.false
messageMessage ContentSTRINGThe content message that will be sent.true
priorityPriorityINTEGERThe priority of the message. If unset, then the default priority of the application will be used.false
extrasExtrasARRAY
Items [{STRING(topNamespace), STRING(subNamespace), STRING(extraInfoKey), STRING(extraInfoValue)}($extra)]
The extra data sent along the message.false

Example JSON Structure

{
  "label" : "Send Message",
  "name" : "sendMessage",
  "parameters" : {
    "title" : "",
    "message" : "",
    "priority" : 1,
    "extras" : [ {
      "topNamespace" : "",
      "subNamespace" : "",
      "extraInfoKey" : "",
      "extraInfoValue" : ""
    } ]
  },
  "type" : "gotify/v1/sendMessage"
}

Output

Type: OBJECT

Properties

NameTypeDescription
idINTEGERID of the message that was sent.
appidINTEGERID of the app that sent the message.
messageSTRINGContent of the message that was sent.
titleSTRINGTitle of the message that was sent.
priorityINTEGERPriority of the message that was sent.
extrasOBJECT
Properties {{{STRING(extra_info)}(sub_namespace)}(top_namespace)}
Extras of the message that was sent.
dateSTRINGDate when the message was sent.

Output Example

{
  "id" : 1,
  "appid" : 1,
  "message" : "",
  "title" : "",
  "priority" : 1,
  "extras" : {
    "top_namespace" : {
      "sub_namespace" : {
        "extra_info" : ""
      }
    }
  },
  "date" : ""
}

Additional instructions