Add webhook event for saving entry

1 files changed, 107 insertions, 13 deletions

diff --git a/internal/integration/webhook/webhook.go b/internal/integration/webhook/webhook.go
index 766c54a3..edc5a840 100644
--- a/internal/integration/webhook/webhook.go
+++ b/internal/integration/webhook/webhook.go
@@ -15,7 +15,12 @@ import (
 	"miniflux.app/v2/internal/version"
 )
 
-const defaultClientTimeout = 10 * time.Second
+const (
+	defaultClientTimeout = 10 * time.Second
+
+	NewEntriesEventType = "new_entries"
+	SaveEntryEventType  = "save_entry"
+)
 
 type Client struct {
 	webhookURL    string
@@ -26,17 +31,71 @@ func NewClient(webhookURL, webhookSecret string) *Client {
 	return &Client{webhookURL, webhookSecret}
 }
 
-func (c *Client) SendWebhook(feed *model.Feed, entries model.Entries) error {
-	if c.webhookURL == "" {
-		return fmt.Errorf(`webhook: missing webhook URL`)
-	}
+func (c *Client) SendSaveEntryWebhookEvent(entry *model.Entry) error {
+	return c.makeRequest(SaveEntryEventType, &WebhookSaveEntryEvent{
+		EventType: SaveEntryEventType,
+		Entry: &WebhookEntry{
+			ID:          entry.ID,
+			UserID:      entry.UserID,
+			FeedID:      entry.FeedID,
+			Status:      entry.Status,
+			Hash:        entry.Hash,
+			Title:       entry.Title,
+			URL:         entry.URL,
+			CommentsURL: entry.CommentsURL,
+			Date:        entry.Date,
+			CreatedAt:   entry.CreatedAt,
+			ChangedAt:   entry.ChangedAt,
+			Content:     entry.Content,
+			Author:      entry.Author,
+			ShareCode:   entry.ShareCode,
+			Starred:     entry.Starred,
+			ReadingTime: entry.ReadingTime,
+			Enclosures:  entry.Enclosures,
+			Tags:        entry.Tags,
+			Feed: &WebhookFeed{
+				ID:        entry.Feed.ID,
+				UserID:    entry.Feed.UserID,
+				FeedURL:   entry.Feed.FeedURL,
+				SiteURL:   entry.Feed.SiteURL,
+				Title:     entry.Feed.Title,
+				CheckedAt: entry.Feed.CheckedAt,
+			},
+		},
+	})
+}
 
+func (c *Client) SendNewEntriesWebhookEvent(feed *model.Feed, entries model.Entries) error {
 	if len(entries) == 0 {
 		return nil
 	}
 
-	webhookEvent := &WebhookEvent{
-		// Send only a subset of the fields to avoid leaking sensitive data.
+	var webhookEntries []*WebhookEntry
+	for _, entry := range entries {
+		webhookEntries = append(webhookEntries, &WebhookEntry{
+			ID:          entry.ID,
+			UserID:      entry.UserID,
+			FeedID:      entry.FeedID,
+			Status:      entry.Status,
+			Hash:        entry.Hash,
+			Title:       entry.Title,
+			URL:         entry.URL,
+			CommentsURL: entry.CommentsURL,
+			Date:        entry.Date,
+			CreatedAt:   entry.CreatedAt,
+			ChangedAt:   entry.ChangedAt,
+			Content:     entry.Content,
+			Author:      entry.Author,
+			ShareCode:   entry.ShareCode,
+			Starred:     entry.Starred,
+			ReadingTime: entry.ReadingTime,
+			Enclosures:  entry.Enclosures,
+			Tags:        entry.Tags,
+		})
+	}
+
+	return c.makeRequest(NewEntriesEventType, &WebhookNewEntriesEvent{
+		EventType: NewEntriesEventType,
 		Feed: &WebhookFeed{
 			ID:        feed.ID,
 			UserID:    feed.UserID,
@@ -45,10 +104,16 @@ func (c *Client) SendWebhook(feed *model.Feed, entries model.Entries) error {
 			Title:     feed.Title,
 			CheckedAt: feed.CheckedAt,
 		},
-		Entries: entries,
+		Entries: webhookEntries,
+	})
+}
+
+func (c *Client) makeRequest(eventType string, payload any) error {
+	if c.webhookURL == "" {
+		return fmt.Errorf(`webhook: missing webhook URL`)
 	}
 
-	requestBody, err := json.Marshal(webhookEvent)
+	requestBody, err := json.Marshal(payload)
 	if err != nil {
 		return fmt.Errorf("webhook: unable to encode request body: %v", err)
 	}
@@ -61,6 +126,7 @@ func (c *Client) SendWebhook(feed *model.Feed, entries model.Entries) error {
 	request.Header.Set("Content-Type", "application/json")
 	request.Header.Set("User-Agent", "Miniflux/"+version.Version)
 	request.Header.Set("X-Miniflux-Signature", crypto.GenerateSHA256Hmac(c.webhookSecret, requestBody))
+	request.Header.Set("X-Miniflux-Event-Type", eventType)
 
 	httpClient := &http.Client{Timeout: defaultClientTimeout}
 	response, err := httpClient.Do(request)
@@ -70,7 +136,7 @@ func (c *Client) SendWebhook(feed *model.Feed, entries model.Entries) error {
 	defer response.Body.Close()
 
 	if response.StatusCode >= 400 {
-		return fmt.Errorf("webhook: incorrect response status code: url=%s status=%d", c.webhookURL, response.StatusCode)
+		return fmt.Errorf("webhook: incorrect response status code %d for url %s", response.StatusCode, c.webhookURL)
 	}
 
 	return nil
@@ -85,7 +151,35 @@ type WebhookFeed struct {
 	CheckedAt time.Time `json:"checked_at"`
 }
 
-type WebhookEvent struct {
-	Feed    *WebhookFeed  `json:"feed"`
-	Entries model.Entries `json:"entries"`
+type WebhookEntry struct {
+	ID          int64               `json:"id"`
+	UserID      int64               `json:"user_id"`
+	FeedID      int64               `json:"feed_id"`
+	Status      string              `json:"status"`
+	Hash        string              `json:"hash"`
+	Title       string              `json:"title"`
+	URL         string              `json:"url"`
+	CommentsURL string              `json:"comments_url"`
+	Date        time.Time           `json:"published_at"`
+	CreatedAt   time.Time           `json:"created_at"`
+	ChangedAt   time.Time           `json:"changed_at"`
+	Content     string              `json:"content"`
+	Author      string              `json:"author"`
+	ShareCode   string              `json:"share_code"`
+	Starred     bool                `json:"starred"`
+	ReadingTime int                 `json:"reading_time"`
+	Enclosures  model.EnclosureList `json:"enclosures"`
+	Tags        []string            `json:"tags"`
+	Feed        *WebhookFeed        `json:"feed,omitempty"`
+}
+
+type WebhookNewEntriesEvent struct {
+	EventType string          `json:"event_type"`
+	Feed      *WebhookFeed    `json:"feed"`
+	Entries   []*WebhookEntry `json:"entries"`
+}
+
+type WebhookSaveEntryEvent struct {
+	EventType string        `json:"event_type"`
+	Entry     *WebhookEntry `json:"entry"`
 }