Getting started

Introduction How Convoy works Quickstart: join a deployment Quickstart: run from source

Deploy Convoy

Deploy Convoy Deploy the Convex Backend Auth and Clerk Deploy to Vercel Email and Resend Deploy the Docs Site Production Checklist Self-hosting Convex

Using Convoy

Using Convoy Organizations, projects, and members Tasks Comments, attachments, and artifacts AI threads Keyboard shortcuts

CLI & AI integrations

CLI & AI integrations overview API keys Install the CLI Setup and connect Profiles, paths, and status Model provider keys

Skills One-shot commands Security model Isolation options

CLI troubleshooting

Operations

Operations Running the CLI long-term Scaling and limits Monitoring and logs Migrations Backups and rollback Upgrading Debugging FAQ

Contributing

Contributing overview Testing Specs-First Workflow CLI architecture and lifecycle Adding a runtime Authoring docs

Reference

Reference overview CLI command reference Config file (config.toml)Environment Variables MCP tools Glossary Roadmap

Email and Resend

Configure transactional email delivery for invitations and onboarding flows.

Convoy can send live transactional emails through Resend.

Current Email Use Cases

organization invitations
onboarding or welcome flows tied to invitations
project-add invitation notifications

Required Configuration

Set:

RESEND_API_KEY
EMAIL_FROM
NEXT_PUBLIC_APP_URL in the Convex dashboard if email links should target a non-default app host

Best Practices

use a verified sending domain
verify that links resolve to the correct production URL. If NEXT_PUBLIC_APP_URL is unset, email links default to https://app.convoy.build
test invitation flows end to end before launch

Deploy to Vercel

Deploy the Convoy Next.js web app to Vercel with integrated Convex deployment.

Deploy the Docs Site

Build and deploy the Convoy documentation site.

On this page

Current Email Use Cases Required Configuration Best Practices