Skip to content

PersistentAI API Documentation / @persistentai/fireflow-vfs / / generateLakeFSActionConfig

Function: generateLakeFSActionConfig()

generateLakeFSActionConfig(webhookUrl): string

Defined in: packages/fireflow-vfs/src/utils/action-config.ts:28

Generate lakeFS action configuration YAML for FireFlow VFS webhook integration

This action file is deployed to _lakefs_actions/fireflow.yaml in each workspace repository. It configures lakeFS to send webhook notifications to FireFlow on:

  • post-commit: After any commit (file changes)
  • post-merge: After branch merges
  • post-create-branch: After new branch creation
  • post-delete-branch: After branch deletion

Parameters

webhookUrl

string

The backend webhook endpoint URL Read from VFS_LAKEFS_WEBHOOK_URL env var at workspace creation time. This is embedded directly because lakeFS URL field doesn't support double-brace ENV templates.

Note: The X-Webhook-Secret header uses a lakeFS SecureString template for the secret header because lakeFS Headers field DOES support SecureString templates.

See: https://docs.lakefs.io/howto/hooks/

Returns

string

Licensed under BUSL-1.1