feat(alerting): ClickUp alerting provider #1462

TheBinaryGuy · 2025-12-21T15:16:45Z

Summary

Checklist

Tested and/or added tests to validate that the changes work as intended, if applicable.
Updated documentation in README.md, if applicable.

PythonGermany · 2025-12-21T18:00:56Z

alerting/provider/clickup/clickup.go

+}
+
+func (provider *AlertProvider) CloseTask(cfg *Config, ep *endpoint.Endpoint) error {
+	fetchURL := fmt.Sprintf("https://api.clickup.com/api/v2/list/%s/task?include_closed=false", cfg.ListID)


If I understand correctly cfg.APIURL should be used here instead of the default one.

Sorry about that, updated, APIURL is now more generic (just the base) and other parts are now using it to construct the full URL.

PythonGermany · 2025-12-21T18:01:07Z

alerting/provider/clickup/clickup.go

+}
+
+func (provider *AlertProvider) UpdateTaskStatus(cfg *Config, taskID, status string) error {
+	updateURL := fmt.Sprintf("https://api.clickup.com/api/v2/task/%s", taskID)


cfg.APIURL here as well.

alerting/provider/clickup/clickup.go

PythonGermany · 2025-12-21T18:06:36Z

README.md

+| `alerting.clickup`                   | Configuration for alerts of type `clickup`                                                 | `{}`          |
+| `alerting.clickup.list-id`           | ClickUp List ID where tasks will be created                                                | Required `""` |
+| `alerting.clickup.token`             | ClickUp API token                                                                          | Required `""` |
+| `alerting.clickup.api-url`           | Custom API URL (optional, defaults to `https://api.clickup.com/api/v2/list/{list-id}/task`) | `""`          |


Default value should be moved to default column.

PythonGermany · 2025-12-21T18:07:00Z

README.md

+| `alerting.clickup.name`              | Custom task name template (supports placeholders)                                          | `""`          |
+| `alerting.clickup.content`           | Custom task content template (supports placeholders)                                       | `""`          |


Documented default values do not match default values in code.

PythonGermany · 2025-12-22T15:00:17Z

This provider does not support global overriding of config values based on the group the endpoint is in. I've not noticed most other alert providers (not all though) support it. @TwiN Is it a requirement that new providers support this?

TheBinaryGuy · 2025-12-22T16:16:31Z

@PythonGermany Should I port it from the Datadog Provider?

PythonGermany · 2025-12-22T16:41:21Z

If it's not too much trouble. If you want to be sure I'd wait for feedback from TwiN as I am not sure why some providers implement it and some not.

The changes required in the provider GetConfig method seem to be straightforward. To me it looks like many providers reimplement the same GetConfig method, I added the same implementation as to the alert provider I'm currently working on.

I wonder why this functionality is not implemented somewhere once like a template and then reused for every provider.

…om/TwiN/gatus/v5/client from http.Client

…pdated README

TheBinaryGuy · 2025-12-22T21:02:20Z

@PythonGermany Not a big deal, just lifted it from the datadog provider. Let me know if it requires any changes! If you decide to go the template route, I'd be happy to change the provider to match that.

PythonGermany · 2025-12-23T17:22:06Z

alerting/provider/clickup/clickup.go

 	if override.Status != "" {
 		cfg.Status = override.Status
 	}
 	if override.Priority != 0 {


Is priority '0' a possible valid input as override priority in ClickUp alerts? If yes, a the config priority member could be a bool pointer and then check for nil to see if it is set in the override config.

No, priority has to be between 1 to 4, I have added validation for it now as well in the Validate function

Wouldn't priority 3 be a reasonable default then if no manual priority was set in the config or override config? What happens with the task priority if it is not set and the POST request body for to create the task has value '0' set as priority?

Yeah I think you are right, setting 0 / nil both are creating a task with no priority assigned (we are using Urgent in our deployment, but I think Normal is a better default for others).

Should I make the default 3 then?

Also while 0 is working, the ClickUp docs suggests to just omit it, it might not work in the future, so should I also add a bool pointer as you suggested for folks who want to deliberately set No Priority.

What I am thinking is no-priority config option, if set, priority won't be validated or sent to ClickUp, if not set, provided priority (or default = 3) will be validated and used.

What I am thinking is no-priority config option, if set, priority won't be validated or sent to ClickUp

Good point, I did not think about the scenario where no priority might be wanted instead of the default. An alternative to adding another option (where we would have to explain in the docs how it impacts the other option) I would suggest to allow 0 as input for priority and just add the priority config value to the create task request body if its not nil and not 0.

so should I also add a bool pointer as you suggested for folks who want to deliberately set No Priority

Should I make the default 3 then?

Yes, making it a bool pointer and default priority Normal sounds good.

Do the people who might configure ClickUp as an alert provider usually know which priority number corresponds to which priority name?

If not it might make improve usability to set the priority option as a string and map the string values to the right number before the API call, with an additional None value input allowed which maps to null in the API call.

Sorry about all the questions. It's interesting how the devil's always in the details 😅

I don't think we can assume they will know, so I was adding the description in the README, but I like your idea of a map a lot more, better ux + also supports the None scenario well.

Done, I have also added instructions on how to get assignee ids and made notify-all configurable (defaults to true)

alerting/provider/clickup/clickup.go

Co-authored-by: PythonGermany <[email protected]>

TwiN · 2025-12-25T00:30:45Z

GitHub mobile is being silly and won't let me submit a code review, but please remove the overrides from the example. I try to keep the examples as short as possible since the documentation is already quite lengthy .

TheBinaryGuy · 2025-12-25T14:23:49Z

@TwiN Done

TwiN · 2025-12-26T19:05:27Z

GitHub mobile is still being silly, but please remove the unnecessary empty newlines inside functions, and then I think we're good to merge!

TheBinaryGuy · 2025-12-26T19:56:25Z

@TwiN No worries, removed

TwiN · 2025-12-27T00:39:58Z

@TheBinaryGuy Thank you for the contribution, and great work!

@PythonGermany Thank you for the assist!

TheBinaryGuy · 2025-12-27T00:43:00Z

Thank you @PythonGermany and @TwiN and thanks for maintaining this amazing project!

github-actions bot added feature New feature or request area/alerting Related to alerting labels Dec 21, 2025

PythonGermany reviewed Dec 21, 2025

View reviewed changes

TheBinaryGuy added 5 commits December 23, 2025 02:25

feat(alerting): Add ClickUp alerting provider

abdeee9

test: added ClickUp tests, docs in README and switch http to github.c…

8418ceb

…om/TwiN/gatus/v5/client from http.Client

docs: Update ClickUp API token instructions in README

edcc3a6

fix(alerting): Update ClickUp alert configuration and default values

0159db4

docs: fixed formatting and removed line breaks from content in README

58e38ba

TheBinaryGuy force-pushed the master branch from 7c14d28 to 58e38ba Compare December 22, 2025 20:56

feat(alerting): Add group-specific overrides and validation checks, u…

bf4f89c

…pdated README

PythonGermany reviewed Dec 23, 2025

View reviewed changes

TheBinaryGuy and others added 6 commits December 25, 2025 00:00

Update alerting/provider/clickup/clickup.go

ce27cb2

Co-authored-by: PythonGermany <[email protected]>

fix(alerting): add priority validation

5ba16af

fix(alerting): set default priority to 3

a7ade7e

feat(alerting): add priority map for ClickUp provider

18f7bf9

feat(alerting): make notify-all configurable for ClickUp provider

2a46916

docs: add instructions for finding Assignee IDs for ClickUp

ab9fa67

refactor(alerting): simplified ClickUp configurations example

4910b1b

refactor(alerting): clean up new lines in ClickUp provider

fccd0c2

TwiN merged commit 2d5f0a5 into TwiN:master Dec 27, 2025
2 checks passed

		\| `alerting.clickup.name` \| Custom task name template (supports placeholders) \| `""` \|
		\| `alerting.clickup.content` \| Custom task content template (supports placeholders) \| `""` \|

Uh oh!

feat(alerting): ClickUp alerting provider #1462

feat(alerting): ClickUp alerting provider #1462

Uh oh!

Conversation

TheBinaryGuy commented Dec 21, 2025

Summary

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PythonGermany Dec 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PythonGermany commented Dec 22, 2025

Uh oh!

TheBinaryGuy commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

PythonGermany commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TheBinaryGuy commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PythonGermany Dec 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

TwiN commented Dec 25, 2025

Uh oh!

TheBinaryGuy commented Dec 25, 2025

Uh oh!

TwiN commented Dec 26, 2025

Uh oh!

TheBinaryGuy commented Dec 26, 2025

Uh oh!

Uh oh!

TwiN commented Dec 27, 2025

Uh oh!

TheBinaryGuy commented Dec 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

PythonGermany Dec 21, 2025 •

edited

Loading

TheBinaryGuy commented Dec 22, 2025 •

edited

Loading

PythonGermany commented Dec 22, 2025 •

edited

Loading

TheBinaryGuy commented Dec 22, 2025 •

edited

Loading

PythonGermany Dec 24, 2025 •

edited

Loading