woodpecker-ntfy

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

Configuration

Name	Description	Default
message	Notification Body	none
title	Notification Title 1	none
priority	Notification Priority 2	none
url	Url (including the topic) to send the notification to	https://ntfy.sh/woodpecker-ntfy
token	Authentication token for write-protected topics 3	none
actions	Action Buttons 4	none
attach	Url for file to be attached 5	none
call	Phone number to send voice message to 6 (ntfy >= 2.5.0)	none
click	Click Action 7	CI_BUILD_LINK
email	E-mail to which the message is to be forwarded 8	none
icon	Message Icon 9	CI_COMMIT_AUTHOR_AVATAR
tags	Tags and Emojis 10	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}

Footnotes

1. https://docs.ntfy.sh/publish/#message-title ↩

2. https://docs.ntfy.sh/publish/#message-priority ↩

3. https://docs.ntfy.sh/publish/#bearer-auth ↩

4. https://docs.ntfy.sh/publish/#defining-actions ↩

5. https://docs.ntfy.sh/publish/#attach-file-from-a-url ↩

6. https://docs.ntfy.sh/publish/#phone-calls ↩

7. https://docs.ntfy.sh/publish/#click-action ↩

8. https://docs.ntfy.sh/publish/#e-mail-notifications ↩

9. https://docs.ntfy.sh/publish/#icons ↩

10. https://docs.ntfy.sh/publish/#tags-emojis ↩