Convoy llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/convoy/llms-txt) # Convoy llms.txt Browse Convoy documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. getconvoy.io/llms.txt [Raw llms.txt](https://getconvoy.io/docs/llms.txt) [Raw llms-full.txt](https://getconvoy.io/llms-full.txt) Copy Markdown [](https://getconvoy.io/llms.txt) llms.txt Docs Authentication List delivery attempts Retrieve a delivery attempt Activate endpoint Create an endpoint Delete endpoint List all endpoints Pause endpoint Retrieve endpoint Roll endpoint secret Test OAuth2 connection Update an endpoint Errors Batch retry event delivery Force retry event delivery List all event deliveries Retrieve an event delivery Retry event delivery Create an event type Deprecates an event type Import event types from OpenAPI spec Retrieves a project's event types Updates an event type Batch replay events Create a broadcast event Create an event Dynamic Events Fan out an event List all events Replay event Retrieve an event Create multiple subscription filters Update multiple subscription filters Create a new filter Delete a filter List all filters Get a filter Test a filter Update a filter List all meta events Retrieve a meta event Retry meta event Bulk onboard endpoints with subscriptions Pagination Create a portal link List all portal links Get a portal link auth token Retrieve a portal link Revoke a portal link Update a portal link Create a project Delete a project List all projects Retrieve a project Update a project Create a source Delete a source List all sources Retrieve a source Update a source Validate source function Create a subscription Delete subscription List all subscriptions Retrieve a subscription Test a subscription function Update a subscription Validate subscription filter Versioning Welcome Licensing Paid Features Single Sign-On (SAML) CLI Convoy CLI Convoy Cloud Subscription and Access Policy Convoy Cloud Upgrade Policy Architecture Configuration AKS (Azure Kubernetes Service) Docker Kubernetes Troubleshooting PostgreSQL & PGBouncer Redis & Redis Sentinel FAQ Dead Endpoints Delivery Attempts Endpoints Event delivery Event Types Events Hash Functions Glossary Projects Rate Limiting Endpoints Replay Attacks Retry Schedule Secrets API-driven onboarding Best practices for generating webhook events Receive Your First Webhook Event Send Your First Webhook Event Introduction Quickstart Software License Agreement Support Policy Circuit Breaker Custom Certificate Authority Endpoint verification and outbound connections Endpoints Events and Event Deliveries Filters Nginx Smokescreen Functions Google Single Sign-On (SSO) Idempotency Apache Kafka Google PubSub RabbitMQ Amazon SQS Meta Events Metrics Organizations and Projects Portal Links Rate Limits Role-Based Access Control (RBAC) Read Replicas Retention Policy Signatures Sources Subscriptions Webhooks Documentation Feature Flags Telemetry SDK Webhook Security: Tackling SSRF Webhook retries OpenAPI Specs openapi Optional Community GitHub Status ## What is Convoy's llms.txt? Convoy publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Convoy offers and where to find details. Pass Spec 3 Sections 143 Links 17.1 KB Size ~4.4k Tokens Sections: Docs · OpenAPI Specs · Optional ## Add Convoy Docs to Your AI Assistant Select your tool to see how to add Convoy's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://getconvoy.io/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Convoy Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 3 notes ## Frequently Asked Questions Where is Convoy's llms.txt file? Convoy publishes its llms.txt at https://getconvoy.io/llms.txt. This file provides a structured, markdown-formatted index of Convoy's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Convoy's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Convoy's documentation so it can provide better code suggestions and answers about Convoy. What does Convoy's llms.txt contain? Convoy's llms.txt contains 3 sections and 143 documentation links in 17.1 KB (~4.4k tokens). Key sections include Docs, OpenAPI Specs, Optional. How many tokens does Convoy's llms.txt use? The concise llms.txt index is approximately 4.4k tokens (17.1 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is Convoy? The Cloud Native Webhooks Gateway. Convoy's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Convoy. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Plane Plane is a modern project management system for fast-growing teams and enterprises.](https://mdream.dev/llms-txt/convoy/llms-txt/plane) [Font Awesome Docs Official documentation for Font Awesome icons.](https://mdream.dev/llms-txt/convoy/llms-txt/font-awesome) [XState State machines and statecharts for the modern web. XState is a JavaScript/TypeScript library for creating state machines, statecharts, and actors.](https://mdream.dev/llms-txt/convoy/llms-txt/xstate) [Gogs: A painless self-hosted Git service Gogs is a painless self-hosted Git service](https://mdream.dev/llms-txt/convoy/llms-txt/gogs) [Chainlit Build Conversational AI in minutes ⚡️](https://mdream.dev/llms-txt/convoy/llms-txt/chainlit) [Elastic Documentation Elastic provides an open source search, analytics, and AI platform, and out-of-the-box solutions for observability and security. The Search AI platform combines the power of search and generative AI to provide near real-time search and analysis with relevance to reduce your time to value.](https://mdream.dev/llms-txt/convoy/llms-txt/elastic) [Finch](https://mdream.dev/llms-txt/convoy/llms-txt/finch) [Split docs Documentation](https://mdream.dev/llms-txt/convoy/llms-txt/split) [View all 99 projects ](https://mdream.dev/llms-txt/convoy/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/convoy/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/convoy/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)