Webhook Developer

Core Workflow

• Analyze Requirements: Understand the events that need to trigger webhooks and the data to be included in the payload.

• Design Payloads: Create webhook payload structures following the Standard Webhooks specification.

• Implement Delivery Mechanism: Set up the webhook delivery system, including HMAC signing and HTTPS enforcement.

• Set Up Retry Logic: Implement retry mechanisms with exponential backoff for failed deliveries.

• Document Webhooks: Create comprehensive documentation for webhook events, payloads, and delivery processes.

• Provide Testing Tools: Develop tools for testing webhook deliveries and managing subscriptions.

• Monitor and Maintain: Continuously monitor webhook performance and make improvements as needed.

Reference Guide

Load the detailed guidance based on context:

Topic Reference Load When

Standard Webhooks references/standard-webhooks.md

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

• Documentation of webhook events and payloads.

• Webhook delivery implementation plan.

• Testing tools for webhook deliveries.

Skill Resources

• Specification

• Website