Velt Rest Apis Best Practices: Install, Source and Security | FunnelSlayer
FunnelSlayer
Book a call

Velt Rest Apis Best Practices

Published by velt-js in agent-skills

Review recommended29 installs

What this skill does

Velt REST API v2 and webhook best practices for server-side integration. Use when calling Velt REST API v2 endpoints, generating JWT tokens for frontend authentication, handling Velt webhooks (comment events, huddle events, CRDT updates), managing users/documents/organizations via REST, or implementing server-side Velt operations. Triggers on any task involving Velt REST API, JWT token generation for Velt, Velt webhooks, x-velt-api-key headers, or server-side comment/notification/activity manage

Add Velt Rest Apis Best Practices to your agent

Review the source and files first. When you are ready, copy the prompt instruction or use the CLI command supported by your environment.

Install with a prompt

Paste this into a compatible coding agent:

add this skill "velt-rest-apis-best-practices" from https://github.com/velt-js/agent-skills

Install with the CLI

Run this command in a controlled environment after reviewing the repository:

npx skills add https://github.com/velt-js/agent-skills --skill velt-rest-apis-best-practices

Skill instructions

Velt REST APIs Best Practices

Comprehensive guide for Velt REST API v2, JWT authentication, and webhooks. Contains 12 rules across 4 categories covering core setup, REST API endpoints, webhook handling, and debugging.

When to Apply

Reference these guidelines when:

  • Calling Velt REST API v2 endpoints from your backend
  • Generating JWT tokens for frontend user authentication
  • Handling Velt webhook events (comments, huddles, CRDT)
  • Managing users, documents, organizations, or folders server-side
  • Implementing GDPR data export or deletion

Rule Categories by Priority

PriorityCategoryImpactPrefix
1Core SetupCRITICALcore-
2REST APIHIGHrest-
3WebhooksMEDIUMwebhooks-
4DebuggingLOW-MEDIUMdebug-

Quick Reference

Core Setup (CRITICAL)

  • core-rest-api-auth — x-velt-api-key + x-velt-auth-token headers for all REST calls
  • core-jwt-tokens — Generate JWT tokens for frontend auth, 48h expiry, refresh flow

REST API (HIGH)

  • rest-comments — Comment annotation + comment CRUD endpoints
  • rest-users — Add/get/update/delete users, GDPR data operations
  • rest-documents-orgs — Document, organization, folder management
  • rest-notifications — Notification add/get/update/delete + config
  • rest-activities-crdt — Activity logs + CRDT data endpoints
  • rest-advanced-webhooks — Manage advanced webhooks: config enable + endpoint CRUD + signing-secret retrieval
  • rest-agents — List agent execution history with pagination and status filters
  • rest-memory — Memory judgments, knowledge ingestion/search, Q&A, suggestions, insights, and alerts
  • rest-approval-engine — pointer (Approval Engine is now its own skill: see velt-approval-engine-best-practices)

Webhooks (MEDIUM)

  • webhooks-basic — v1 setup, event types, payload format, security
  • webhooks-advanced — v2/Svix enterprise webhooks, retries, transformations

Debugging (LOW-MEDIUM)

  • debug-common-issues — Troubleshooting backend integration issues

Compiled Documents

  • AGENTS.md — Compressed index of all rules with file paths (start here)
  • AGENTS.full.md — Full verbose guide with all rules expanded inline

Files included

  • AGENTS.full.md
  • AGENTS.md
  • metadata.json
  • rules/shared/_sections.md
  • rules/shared/core/core-jwt-tokens.md
  • rules/shared/core/core-rest-api-auth.md
  • rules/shared/debug/debug-common-issues.md
  • rules/shared/rest-api/rest-activities-crdt.md
  • rules/shared/rest-api/rest-advanced-webhooks.md
  • rules/shared/rest-api/rest-agents.md
  • rules/shared/rest-api/rest-approval-engine.md
  • rules/shared/rest-api/rest-comments.md
  • rules/shared/rest-api/rest-documents-orgs.md
  • rules/shared/rest-api/rest-memory.md
  • rules/shared/rest-api/rest-notifications.md
  • rules/shared/rest-api/rest-users.md
  • rules/shared/webhooks/webhooks-advanced.md
  • rules/shared/webhooks/webhooks-basic.md
  • SKILL.md