confluence

package

v0.99.10 Latest Latest Go to latest Published: Aug 30, 2026 License: GPL-3.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/flowline-io/flowbot

Links

Open Source Insights

Documentation ¶

Overview ¶

Package confluence implements the Confluence Cloud capability adapter.

Package confluence implements the Confluence Cloud capability.

Index ¶

Constants
func CatalogSpec() capability.Spec
func Register(app string, svc Service) error
type Adapter
type ListQuery
type Service
- func New() Service
- func NewWithClient(c client) Service
type Webhook
- func NewWebhook() *Webhook

Constants ¶

View Source

const (
	OpListSpaces     = "list_spaces"
	OpListPages      = "list_pages"
	OpGetPage        = "get_page"
	OpGetPageContent = "get_page_content"
	OpSearchPages    = "search_pages"
	OpCreatePage     = "create_page"
	OpUpdatePage     = "update_page"
	OpDeletePage     = "delete_page"
	OpHealth         = "health"
)

Variables ¶

This section is empty.

Functions ¶

func CatalogSpec ¶

func CatalogSpec() capability.Spec

CatalogSpec returns capability metadata for documentation.

func Register ¶

func Register(app string, svc Service) error

Register registers the confluence capability with hub and invoker registry.

Types ¶

type Adapter ¶

type Adapter struct {
	// contains filtered or unexported fields
}

Adapter implements Service using the Confluence provider client.

func (*Adapter) CreatePage ¶

func (a *Adapter) CreatePage(ctx context.Context, spaceKey, title, content string) (*capability.ConfluencePage, error)

func (*Adapter) DeletePage ¶

func (a *Adapter) DeletePage(ctx context.Context, pageID string) error

func (*Adapter) GetPage ¶

func (a *Adapter) GetPage(ctx context.Context, pageID string) (*capability.ConfluencePage, error)

func (*Adapter) GetPageContent ¶

func (a *Adapter) GetPageContent(ctx context.Context, pageID string) (string, error)

func (*Adapter) HealthCheck ¶

func (a *Adapter) HealthCheck(ctx context.Context) (bool, error)

func (*Adapter) ListPages ¶

func (a *Adapter) ListPages(ctx context.Context, spaceKey string, q *ListQuery) (*capability.ListResult[capability.ConfluencePage], error)

func (*Adapter) ListSpaces ¶

func (a *Adapter) ListSpaces(ctx context.Context, q *ListQuery) (*capability.ListResult[capability.ConfluenceSpace], error)

func (*Adapter) SearchPages ¶

func (a *Adapter) SearchPages(ctx context.Context, cql string, q *ListQuery) (*capability.ListResult[capability.ConfluencePage], error)

func (*Adapter) UpdatePage ¶

func (a *Adapter) UpdatePage(ctx context.Context, pageID, title, content string) (*capability.ConfluencePage, error)

type ListQuery ¶

type ListQuery struct {
	Page capability.PageRequest
}

ListQuery wraps pagination for list operations.

type Service ¶

type Service interface {
	ListSpaces(ctx context.Context, q *ListQuery) (*capability.ListResult[capability.ConfluenceSpace], error)
	ListPages(ctx context.Context, spaceKey string, q *ListQuery) (*capability.ListResult[capability.ConfluencePage], error)
	GetPage(ctx context.Context, pageID string) (*capability.ConfluencePage, error)
	GetPageContent(ctx context.Context, pageID string) (string, error)
	SearchPages(ctx context.Context, cql string, q *ListQuery) (*capability.ListResult[capability.ConfluencePage], error)
	CreatePage(ctx context.Context, spaceKey, title, content string) (*capability.ConfluencePage, error)
	UpdatePage(ctx context.Context, pageID, title, content string) (*capability.ConfluencePage, error)
	DeletePage(ctx context.Context, pageID string) error
	HealthCheck(ctx context.Context) (bool, error)
}

Service defines the Confluence capability contract.

func New ¶

func New() Service

New creates an Adapter from provider config. Returns nil when not configured.

func NewWithClient ¶

func NewWithClient(c client) Service

NewWithClient creates an Adapter with the given client.

type Webhook ¶

type Webhook struct {
	// contains filtered or unexported fields
}

Webhook implements capability.WebhookConverter for Confluence automation webhooks. Configure Confluence Automation to POST JSON with optional fields:

{"event":"page_created","id":"evt-1","page":{"id":"123","title":"..."},"space":{"key":"DEV"}}

func NewWebhook ¶

func NewWebhook() *Webhook

NewWebhook creates a Webhook that reads the query token from provider config.

func (*Webhook) Convert ¶

func (*Webhook) Convert(body []byte, _ map[string]string) ([]types.DataEvent, error)

Convert transforms an automation webhook payload into DataEvent records.

func (*Webhook) VerifySignature ¶

func (w *Webhook) VerifySignature(headers map[string]string, _ []byte) error

VerifySignature validates the webhook token from the query parameter.

func (*Webhook) WebhookPath ¶

func (*Webhook) WebhookPath() string

WebhookPath returns the URL path segment for Confluence webhooks. Full URL: /webhook/provider/confluence/events?token=TOKEN

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL