webhook-development

SKILL.md

Webhook Development

Table of Contents

Overview

When to Use

Quick Start

Reference Guides

Best Practices

Overview

Build reliable webhook systems with event delivery, signature verification, retry logic, and dead-letter handling for asynchronous integrations.

When to Use

Sending real-time notifications to external systems

Implementing event-driven architectures

Integrating with third-party platforms

Building audit trails and logging systems

Triggering automated workflows

Delivering payment or order notifications

Quick Start

Minimal working example:

{
  "id": "evt_1234567890",
  "timestamp": "2025-01-15T10:30:00Z",
  "event": "order.created",
  "version": "1.0",
  "data": {
    "orderId": "ORD-123456",
    "customerId": "CUST-789",
    "amount": 99.99,
    "currency": "USD",
    "items": [
      {
        "productId": "PROD-001",
        "quantity": 2,
        "price": 49.99
      }
    ],
    "status": "pending"
  },
  "attempt": 1,
  "retryable": true
}

Reference Guides

Detailed implementations in the references/ directory:

Guide
Contents

Webhook Event Schema
Webhook Event Schema

Node.js Webhook Service
Node.js Webhook Service

Python Webhook Handler
Python Webhook Handler

Best Practices
Best Practices, Webhook Events

Best Practices

✅ DO

Follow established patterns and conventions

Write clean, maintainable code

Add appropriate documentation

Test thoroughly before deploying

❌ DON'T

Skip testing or validation

Ignore error handling

Hard-code configuration values

1d:[