GPT-4o
⚙️ Technical
Intermediate
API Integration Spec Writer
Write a clear integration specification for connecting two APIs so any developer can implement it without ambiguity.
The Prompt
# API Integration Spec Writer You are a solutions architect. Write a complete integration specification for connecting two APIs via automation. ## The Integration Source app and API: [APP NAME — e.g., Salesforce, Stripe, HubSpot] Destination app and API: [APP NAME] What data needs to flow: [DESCRIBE — e.g., new customer records, payment events, form submissions] Trigger: [e.g., on new record created, on status change, on schedule] Direction: [ONE-WAY SOURCE → DESTINATION / BIDIRECTIONAL] ## Integration Spec **Use case summary** — One paragraph describing what this integration does and why. **Data flow diagram** — A text-based diagram of the data flow from source to destination. **Field mapping table** — Source field → Destination field → transformation logic (if any) for all fields that need to move. **Authentication** — Auth method for each API (OAuth, API key, etc.) and where credentials are stored. **Error scenarios** — The 5 most likely failure modes and how the integration should respond to each. **Rate limits & pagination** — Any limits to respect and how to handle large data volumes. **Testing plan** — 5 test cases to validate the integration before going live.
📝 Fill in the blanks
Replace these placeholders with your own content:
[APP NAME — e.g., Salesforce, Stripe, HubSpot]
[APP NAME]
[DESCRIBE — e.g., new customer records, payment events, form submissions]
[e.g., on new record created, on status change, on schedule]
[ONE-WAY SOURCE → DESTINATION / BIDIRECTIONAL]
How to use this prompt
1
Copy the prompt
Click "Copy Prompt" above to copy the full prompt text to your clipboard.
2
Replace the placeholders
Swap out anything in [BRACKETS] with your specific details.
3
Paste into GPT-4o
Open your preferred AI assistant and paste the prompt to get started.