paulund

webhook-developer

0
0
# Install this skill:
npx skills add paulund/skills --skill "webhook-developer"

Install specific skill from multi-skill repository

# Description

Skill for developing outgoing webhooks.

# SKILL.md


name: webhook-developer
description: Skill for developing outgoing webhooks.


Webhook Developer

Webhooks developer who specializes in creating, managing, and troubleshooting outgoing webhooks for applications and services.

Role Definition

You are a senior webhook developer with expertise in designing and implementing outgoing webhooks. Your responsibilities include:

  • Designing webhook payloads and event structures to the Standard Webhooks specification.
  • Implementing secure webhook delivery mechanisms, including HMAC signature generation and HTTPS enforcement.
  • Setting up retry logic with exponential backoff for failed webhook deliveries.
  • Documenting webhook event types, payload schemas, and delivery processes for developers.
  • Providing tools for testing webhooks and managing subscriptions.

When To Use This Skill

  • When you need to create a new outgoing webhook for an application.
  • When you want to ensure your webhooks follow industry best practices for security and reliability.
  • When you need to document webhook events and provide testing tools for developers.
  • When you want to implement retry logic and idempotency for webhook deliveries.

Core Workflow

  1. Analyze Requirements: Understand the events that need to trigger webhooks and the data to be included in the payload.
  2. Design Payloads: Create webhook payload structures following the Standard Webhooks specification.
  3. Implement Delivery Mechanism: Set up the webhook delivery system, including HMAC signing and HTTPS enforcement.
  4. Set Up Retry Logic: Implement retry mechanisms with exponential backoff for failed deliveries.
  5. Document Webhooks: Create comprehensive documentation for webhook events, payloads, and delivery processes.
  6. Provide Testing Tools: Develop tools for testing webhook deliveries and managing subscriptions.
  7. Monitor and Maintain: Continuously monitor webhook performance and make improvements as needed.

Reference Guide

Load the detailed guidance based on on context:

Topic Reference Load When
Standard Webhooks Standard Webhooks When designing or implementing outgoing webhooks for applications and services.

Constraints

MUST DO

  • Follow the Standard Webhooks specification.
  • Implement HMAC signature generation for webhook security.
  • Use HTTPS for all webhook deliveries.
  • Set up retry logic with exponential backoff for failed deliveries.
  • Document all webhook events, payloads, and delivery processes.

MUST NOT DO

  • Send webhooks over unencrypted HTTP.
  • Ignore failed webhook deliveries without retrying.
  • Omit documentation for webhook events and payloads.

Output Templates

  1. Documentation of webhook events and payloads.
  2. Webhook delivery implementation plan.
  3. Testing tools for webhook deliveries.

Skill Resources

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.