marketplace-order-hook

Configure VTEX order webhooks with Feed v3 and Hook filters.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Build reliable VTEX marketplace order integrations using hooks or feeds, enabling secure, real-time or batched processing of order events with proper validation and idempotency.

Core Features & Use Cases

  • Support both Feed v3 (pull) and Hook (push) delivery models to handle order updates.
  • Distinguish filters FromWorkflow and FromOrders and implement robust status handling with a default fallback.
  • Implement authentication validation, deduplication using OrderId + State + LastChange, and idempotent processing for ERP/WMS integrations.
  • Use cases include syncing orders to ERPs, updating fulfillment, and triggering downstream workflows.

Quick Start

Set up a secure VTEX order hook endpoint, enable appropriate filters, and process events idempotently with proper authentication.

Frequently Asked Questions about marketplace-order-hook

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

FAQPage Schema
How do I configure idempotent VTEX order webhooks for an ERP integration?

To configure idempotent VTEX order webhooks, you set up a secure hook endpoint, apply FromWorkflow or FromOrders filters, and deduplicate events using OrderId, State, and LastChange to ensure safe ERP processing.

What is the difference between VTEX Feed v3 and Hook for order processing?

VTEX Feed v3 uses a pull model where your integration retrieves order events in batches, while Hook uses a push model to deliver real-time order updates directly to your endpoint for immediate processing.

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

Handle unknown VTEX order statuses by implementing a safe fallback mechanism within your hook processing logic, ensuring unrecognized events do not break the integration and can be logged or reviewed.

When should I use FromWorkflow versus FromOrders filters in VTEX order hooks?

Use FromWorkflow filters to capture order events flowing through VTEX fulfillment workflows, and FromOrders to capture standard order lifecycle updates, ensuring your integration receives the correct event scope.

How do I validate authentication for VTEX order webhook endpoints?

Validate VTEX order webhook authentication by verifying incoming request signatures or headers against your configured VTEX app key and token, ensuring only authorized marketplace events trigger your processing logic.