vtex-io-http-routes

Define explicit HTTP route contracts for VTEX IO services.

39|9|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/vtex/ai-skills --skill vtex-io-http-routes
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-http-routes
Source: https://github.com/vtex/ai-skills/tree/main/tracks/vtex-io/skills/vtex-io-http-routes
Command: npx skills add https://github.com/vtex/ai-skills --skill vtex-io-http-routes

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures VTEX IO services expose clear, bounded HTTP contracts by explicitly defining route inputs, outputs, and error handling to improve integration reliability.

Core Features & Use Cases

  • Explicitly declare route IDs, paths, and exposure in service.json and wire them to bounded handlers.
  • Promote middleware-driven concerns (validation, auth, normalization) to reduce duplication and enforce consistency.
  • Apply to webhooks, partner integrations, and callback endpoints requiring predictable contracts and responses.

Quick Start

Review your VTEX IO service and adopt explicit HTTP routes with dedicated handlers and middleware.

Frequently Asked Questions about vtex-io-http-routes

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

FAQPage Schema
How do I define explicit HTTP routes in VTEX IO service.json?

To define explicit HTTP routes in VTEX IO, declare route IDs, paths, and exposure settings within service.json, then wire them to bounded handlers. This ensures predictable inputs and responses for your service endpoints.

How do I validate webhook payloads and route parameters in VTEX IO?

Validate webhook payloads and route parameters in VTEX IO by enforcing route handlers to validate at the boundary. Use middleware for shared concerns like auth and normalization to reduce duplication and ensure consistent data shaping.

What is the best way to structure VTEX IO route handlers for long-running tasks?

The best way to structure VTEX IO route handlers for long-running tasks is to keep handlers thin and separate long-running work into asynchronous or worker flows. This maintains predictable HTTP contracts and prevents endpoint blocking.

Can I use middleware for authentication and validation in VTEX IO HTTP routes?

Yes, you can use middleware for authentication and validation in VTEX IO HTTP routes. Promote middleware-driven concerns to enforce consistency, reduce duplication, and cleanly separate shared logic from your bounded route handlers.

When do I need explicit HTTP route contracts for VTEX IO partner integrations?

You need explicit HTTP route contracts for VTEX IO partner integrations when webhooks, callbacks, or public/private route exposure require predictable inputs, validated headers, and consistently shaped responses to ensure integration reliability.