Skip to main content
Plugins / ntfy

ntfy

by l-x

plugin to send notifications to a ntfy.sh instance


woodpecker-ntfy

A Woodpecker plugin to send notifications to a ntfy.sh instance.

Configuration

Name Description Default
message Notification Body none
title Notification Title ^message-title none
priority Notification Priority ^message-priority none
url Url (including the topic) to send the notification to https://ntfy.sh/woodpecker-ntfy
token Authentication token for write-protected topics ^bearer-auth none
actions Action Buttons ^defining-actions none
attach Url for file to be attached ^attach-file-from-a-url none
call Phone number to send voice message to ^phone-calls (ntfy >= 2.5.0) none
click Click Action ^click-action CI_BUILD_LINK
email E-mail to which the message is to be forwarded ^e-mail-notifications none
icon Message Icon ^icons CI_COMMIT_AUTHOR_AVATAR
tags Tags and Emojis ^tags-emojis none

Example

steps:
    - name: ntfy
      image: codeberg.org/l-x/woodpecker-ntfy
      when:
        - event: push
      settings:
          url: https://custom.ntfy.instance/topic-to-notify
          token:
              from_secret: your-super-secret-ntfy-access-token
          title: Commit by ${CI_COMMIT_AUTHOR} on ${CI_COMMIT_BRANCH}
          priority: urgent
          actions: "view, Open portal, https://home.nest.com/, clear=true; http, Turn down, https://api.nest.com/, body='{\"temperature\": 65}'"
          click: https://where.to.go
          icon: https://woodpecker-ci.org/img/logo.svg
          tags: robot,${CI_REPO_NAME}
          message: ${CI_COMMIT_MESSAGE}