Gotify

Send messages and notifications via a self-hosted Gotify server.

CommunicationAPI key1 actionAll integrations

On this page

Connect
Call it from a workflow
Actions (1)
send_notification
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("gotify", "send_notification", {
    "title": "<title>",
    "message": "<message>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Gotify answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "gotify-send-notification",
  name: "Gotify: Send Notification",
  description: "Calls Gotify when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("gotify", {
      "action": "send_notification",
      "title": "<title>",
      "message": "<message>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/gotify/send_notification" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"title":"<title>","message":"<message>"}}'

Actions

send_notificationin catalog

Send Notification. Send a notification to gotify

Input	Type	Description
`title`required	text	The title of the notification
`message`required	long text	The message to send
`priority`optional	number	The priority of the notification (0-10). 0 is lowest priority.

Details

Id: gotify
Category: Communication
Tags: push, notifications, self-hosted, open-source
Package: @activepieces/piece-gotify@0.4.3
Tier: Community