convex-http-actions

Create and manage HTTP endpoints in Convex applications for webhooks and APIs.

Updated Feb 9, 2025
One-click install
npx skills add https://github.com/obada-jaras/nextboost-starter --skill convex-http-actions-obada-jaras
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-http-actions
Source: https://github.com/obada-jaras/nextboost-starter/tree/main/.cursor/skills/convex-http-actions
Command: npx skills add https://github.com/obada-jaras/nextboost-starter --skill convex-http-actions-obada-jaras

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enables developers to create custom HTTP endpoints within Convex applications, facilitating seamless integration with external services and handling webhooks.

Core Features & Use Cases

  • Webhook Handling: Securely receive and process incoming webhooks from third-party services like Stripe or GitHub.
  • API Endpoints: Define custom API routes for your application, supporting GET, POST, and other HTTP methods.
  • Data Handling: Parse JSON, form data, and raw bytes, and manage file uploads to Convex storage.
  • Authentication: Implement API key or Bearer token authentication for protected endpoints.
  • Use Case: Set up a webhook endpoint to automatically update your database when a new user signs up via Clerk, or create a public API endpoint to fetch real-time data from your Convex backend.

Quick Start

Define a simple GET endpoint at /health that returns a JSON response with a status of "ok".

Frequently Asked Questions about convex-http-actions

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create HTTP endpoints in Convex for webhook reception?

To create HTTP endpoints in Convex, you define custom API routes that securely receive and process incoming webhooks from third-party services like Stripe or GitHub, directly updating your backend database. It supports parsing JSON and form data.

Can I handle file uploads and raw bytes in Convex HTTP endpoints?

Yes, Convex HTTP endpoints can handle file uploads and raw bytes. The endpoints support parsing raw byte payloads and managing file uploads or downloads directly via Convex storage, enabling seamless binary data integration with your serverless functions.

Does Convex support API key and Bearer token authentication for custom routes?

Convex supports API key and Bearer token authentication for custom routes. You can implement these authentication methods to protect your HTTP endpoints, ensuring that only authorized external services can access your protected API routes and data.

What is the best way to expose a public API endpoint to fetch real-time data from a Convex backend?

The best way to expose a public API endpoint for real-time data is by defining custom HTTP routes in Convex. These endpoints support various HTTP methods like GET and POST, allowing external applications to fetch real-time data directly from your Convex backend.

How do I configure CORS for HTTP endpoints in Convex?

You can configure CORS for HTTP endpoints in Convex during the route creation process. Setting CORS headers allows your custom API endpoints to securely handle cross-origin requests from web applications, ensuring smooth external integration while maintaining data security.

Why do I need custom HTTP endpoints when using Convex serverless functions?

You need custom HTTP endpoints in Convex to facilitate seamless integration with external services that require standard web protocols. They allow you to receive webhooks, parse diverse request formats, and expose public APIs alongside your serverless functions and data models.