spree-events-webhooks

Configure Spree webhook endpoints and in-process event subscribers.

4|Updated Jun 9, 2026
One-click install
npx skills add https://github.com/spree/agent-skills --skill spree-events-webhooks
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: spree-events-webhooks
Source: https://github.com/spree/agent-skills/tree/main/skills/spree-events-webhooks
Command: npx skills add https://github.com/spree/agent-skills --skill spree-events-webhooks

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires spree_api, spree_webhooks, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill allows you to react to Spree events and configure webhooks for integration with external services, making it easier to automate tasks like syncing orders, sending notifications, and integrating with third-party systems.

Core Features & Use Cases

  • Event Reactivity: Respond to Spree lifecycle events such as order completion, payment processing, and shipment updates.
  • Webhook Configuration: Set up and manage webhooks to integrate with external systems for tasks like syncing data, sending notifications, and triggering workflows.
  • Use Case: For a business that wants to automatically sync order data to an ERP system or send notifications to customers when an order is shipped, this Skill can streamline these processes.

Quick Start

Use the spree-events-webhooks skill to configure a webhook endpoint for order completion and set up a subscriber to sync order data to an external service.

Frequently Asked Questions about spree-events-webhooks

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

FAQPage Schema
How do I configure Spree Commerce webhooks for external service integration?

To configure Spree Commerce webhooks for external service integration, you set up outbound webhooks that deliver HTTPS POST requests to external URLs. This requires the spree_api and spree_webhooks dependencies to handle event subscriptions and delivery.

Can I trigger Ruby on Rails side effects when a Spree order completes?

Yes, you can trigger Ruby on Rails side effects when a Spree order completes by creating in-process subscribers. These subscribers listen to Spree lifecycle events like order completion and payment processing to execute internal Ruby code.

What is the best way to sync Spree order data to an ERP system?

The best way to sync Spree order data to an ERP system is by reacting to Spree lifecycle events and configuring outbound webhooks. This automates HTTPS POST deliveries to your ERP system whenever order statuses change or payments are processed.

Does Spree webhook integration require spree_api and spree_webhooks?

Yes, Spree webhook integration requires both spree_api and spree_webhooks dependencies. These components provide the foundational event handling and webhook delivery mechanisms needed to manage subscriptions and send outbound HTTPS POSTs.

How do in-process subscribers differ from outbound webhooks in Spree?

In-process subscribers handle internal Ruby on Rails side effects within the application, whereas outbound webhooks deliver event data via HTTPS POSTs to external URLs. Both mechanisms react to Spree lifecycle events but target different integration endpoints.

Can I send customer notifications automatically when a Spree shipment updates?

Yes, you can send customer notifications automatically when a Spree shipment updates by configuring webhooks. By subscribing to Spree shipment lifecycle events, the integration triggers outbound HTTPS POSTs to your external notification service.