feat(api/v2): add available webhook events endpoint

Add GET /api/v2/webhooks/events, listing the events a webhook target can
subscribe to. Gated on webhooks.enabled via a registrar early-return, mirroring
v1.
This commit is contained in:
kolaente 2026-06-11 20:41:57 +02:00 committed by kolaente
parent 56b1ba47ec
commit 3312716afd
2 changed files with 74 additions and 0 deletions

View File

@ -0,0 +1,54 @@
// Vikunja is a to-do list application to facilitate your life.
// Copyright 2018-present Vikunja and contributors. All rights reserved.
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
package apiv2
import (
"context"
"net/http"
"code.vikunja.io/api/pkg/config"
"code.vikunja.io/api/pkg/models"
"github.com/danielgtaylor/huma/v2"
)
type webhookEventsBody struct {
Body []string `json:"events" doc:"The events a webhook target can subscribe to."`
}
// RegisterWebhookEventRoutes wires the available-webhook-events listing onto the
// Huma API. Like v1, the whole endpoint only exists when webhooks are enabled.
func RegisterWebhookEventRoutes(api huma.API) {
if !config.WebhooksEnabled.GetBool() {
return
}
Register(api, huma.Operation{
OperationID: "webhooks-events-list",
Summary: "List available webhook events",
Description: "Returns every event a webhook target can subscribe to. Use these values when creating or updating a webhook.",
Method: http.MethodGet,
Path: "/webhooks/events",
Tags: []string{"webhooks"},
}, webhookEventsList)
}
func init() { AddRouteRegistrar(RegisterWebhookEventRoutes) }
func webhookEventsList(_ context.Context, _ *struct{}) (*webhookEventsBody, error) {
return &webhookEventsBody{Body: models.GetAvailableWebhookEvents()}, nil
}

View File

@ -46,6 +46,26 @@ func TestHumaInfo(t *testing.T) {
assert.Contains(t, body, "available_migrators")
}
// TestHumaWebhookEvents covers the available-webhook-events listing. The route
// is only registered when webhooks are enabled (the test config default).
func TestHumaWebhookEvents(t *testing.T) {
e, err := setupTestEnv()
require.NoError(t, err)
t.Run("Returns the events", func(t *testing.T) {
rec := humaRequest(t, e, http.MethodGet, "/api/v2/webhooks/events", "", humaTokenFor(t, &testuser1), "")
require.Equal(t, http.StatusOK, rec.Code, "body: %s", rec.Body.String())
var events []string
require.NoError(t, json.Unmarshal(rec.Body.Bytes(), &events))
assert.ElementsMatch(t, models.GetAvailableWebhookEvents(), events)
})
t.Run("Unauthenticated", func(t *testing.T) {
rec := humaRequest(t, e, http.MethodGet, "/api/v2/webhooks/events", "", "", "")
assert.Equal(t, http.StatusUnauthorized, rec.Code, "body: %s", rec.Body.String())
})
}
// TestHumaProjectBackgroundDelete covers removing a project background. It
// mirrors the v1 background_test.go matrix: the owner clears the background
// (and keeps the title), a read-only user is refused.