marketplace-order-hook

Process VTEX marketplace order webhooks with authentication and deduplication.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Build secure, reliable VTEX marketplace order integrations by coordinating real-time webhooks with a backup feed and robust deduplication.

Core Features & Use Cases

  • Real-time webhook support for order updates with strict authentication and idempotent processing
  • Feed v3 backup to catch missed events and ensure eventual consistency
  • Comprehensive order lifecycle handling with FromWorkflow and FromOrders filters, plus a safe default for unknown statuses
  • Easy integration with ERPs, WMS, and fulfillment systems through configurable endpoints and standardized payloads

Quick Start

Configure the hook and deploy a secure endpoint to receive and idempotently process VTEX marketplace order events.

Frequently Asked Questions about marketplace-order-hook

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

FAQPage Schema
How do I build secure VTEX order webhooks for marketplace integrations?

To build secure VTEX order webhooks, you need a system that enforces strict authentication validation for incoming requests and processes order updates idempotently. This ensures real-time marketplace events are safely received without duplicates.

How does webhook idempotency work for VTEX marketplace order processing?

Webhook idempotency for VTEX orders is achieved through deduplication using the OrderId, State, and LastChange fields. This combination prevents duplicate processing of the same order event when real-time webhooks retry or overlap.

What happens if my VTEX webhook misses an order update event?

If a VTEX webhook misses an order update, a Feed v3 backup catches missed events. Configuring backup polling alongside your hook ensures eventual consistency across your order integration even when real-time delivery fails.

How do I handle unknown order statuses in a VTEX marketplace integration?

Handling unknown VTEX order statuses requires a default-safe processing path. Instead of failing, the integration applies a safe default action for unrecognized lifecycle states, ensuring continuous order processing without errors.

Can I use VTEX FromWorkflow and FromOrders filters for webhook order lifecycle tracking?

Yes, you can use FromWorkflow and FromOrders filters for comprehensive order lifecycle tracking. These filters allow your webhook integration to capture specific status transitions across the VTEX marketplace order workflow.

Do I need a backup feed if I already have real-time VTEX order webhooks configured?

Yes, you need a backup feed alongside real-time VTEX order webhooks to guarantee eventual consistency. Webhooks can drop events during network issues, making feed-based polling a necessary fallback for reliable integration.