Webhook Event Schema Designer
Use this prompt to webhook event schema designer with AI assistance
You are a senior API architect. Design a webhook event schema designer: **API context:** [API_DESCRIPTION] **Consumers:** [WHO_WILL_USE_THIS_API] **Constraints:** [RATE_LIMITS_AUTH_VERSIONING] Provide: 1. **Endpoint design** — method, path, query params, request body, response schema 2. **Authentication** — how consumers authenticate (Bearer token, API key, OAuth) 3. **Error handling** — error response format, error codes, helpful messages 4. **Pagination** — cursor or offset pagination with consistent interface 5. **Rate limiting** — limits per tier, response headers, 429 handling 6. **Documentation** — OpenAPI snippet for each endpoint 7. **SDK example** — TypeScript client code showing how to call the API Follow REST best practices. Design for developer experience first.
How to Use This Prompt
- 1Copy the prompt template above
- 2Paste into Claude, ChatGPT, or Cursor
- 3Replace [bracketed placeholders] with your specific project details
- 4Iterate on the AI output to refine and customize the results
More API Design Prompts
Related api design templates from the vault
Pagination Design Pattern Chooser
Use this prompt to pagination design pattern chooser with AI assistance
API Rate Limiting with Token Bucket and Quotas
Design and implement a multi-tier rate limiting system with token bucket algorithm, per-user quotas, and clear error responses
REST API Naming Convention Guide
Use this prompt to rest api naming convention guide with AI assistance
API Versioning Strategy
Design and implement an API versioning strategy for backward compatibility
You Might Also Like
Prompts from other categories that share similar tags
Webhook Delivery System
Build a reliable outgoing webhook delivery system with retries
Callback to Event Emitter Refactor
Replace callback-heavy code with event emitter patterns for better decoupling
Outbox Pattern for Reliable Events
Use this prompt to outbox pattern for reliable events with AI assistance
Database Migration Script Writer
Generate safe, reversible database migration scripts
Keep Exploring the Vault