ntfy

Send push notifications to any device using the ntfy pub/sub service.

CommunicationNo credentials2 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (2)
send_notification
custom_api_call
Details

Connect

Auth type: No credentials (none). Nothing to connect: the actions run without credentials.

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("ntfy", "send_notification", {
    "topic": "<topic>",
    "message": "<message>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("ntfy answered", { output: res.output });
}

defineWorkflow module

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

export default defineWorkflow({
  id: "ntfy-send-notification",
  name: "ntfy: Send Notification",
  description: "Calls ntfy when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("ntfy", {
      "action": "send_notification",
      "topic": "<topic>",
      "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/ntfy/send_notification" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"topic":"<topic>","message":"<message>"}}'

Actions

send_notificationin catalog

Send Notification. Send a notification to ntfy

Input	Type	Description
`topic`required	text	The topic/channel to send the notification to, e.g. test1
`title`optional	text	The title of the notification
`message`required	long text	The message to send
`priority`optional	text	The priority of the notification (1-5). 1 is lowest priority.
`tags`optional	array	The tags for the notification.
`icon`optional	text	The absolute URL to your icon, e.g. https://example.com/communityIcon_xnt6chtnr2j21.png
`actions`optional	long text	Add Action buttons to notifications, see https://docs.ntfy.sh/publish/#action-buttons
`click`optional	text	You can define which URL to open when a notification is clicked, see https://docs.ntfy.sh/publish/#click-action
`delay`optional	text	Let ntfy send messages at a later date, e.g. 'tomorrow, 10am', see https://docs.ntfy.sh/publish/#scheduled-delivery

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

Details

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