# Sitemap

> Semantic map of Reloop documentation. Prefer markdown URLs (append `.md`) for agent consumption. Full curated index: [llms.txt](/docs/llms.txt).

## Documentation

- [Introduction](https://local.reloop.sh/docs/introduction.md)

## Examples

- [Introduction](https://local.reloop.sh/docs/examples.md)

### Node.js

- [Express](https://local.reloop.sh/docs/examples/nodejs/express.md)
- [Next.js](https://local.reloop.sh/docs/examples/nodejs/nextjs.md)

### Python

- [FastAPI](https://local.reloop.sh/docs/examples/python/fastapi.md)
- [Django](https://local.reloop.sh/docs/examples/python/django.md)
- [Flask](https://local.reloop.sh/docs/examples/python/flask.md)

### Go

- [Gin](https://local.reloop.sh/docs/examples/go/gin.md)

### Ruby

- [Rails](https://local.reloop.sh/docs/examples/ruby/rails.md)

### PHP

- [Laravel](https://local.reloop.sh/docs/examples/php/laravel.md)

### Rust

- [Axum](https://local.reloop.sh/docs/examples/rust/axum.md)

### SMTP

- [Introduction](https://local.reloop.sh/docs/examples/smtp/introduction.md)
- [Nodemailer](https://local.reloop.sh/docs/examples/smtp/nodemailer.md)
- [Python](https://local.reloop.sh/docs/examples/smtp/python.md)
- [Go](https://local.reloop.sh/docs/examples/smtp/go.md)
- [Ruby](https://local.reloop.sh/docs/examples/smtp/ruby.md)
- [PHP](https://local.reloop.sh/docs/examples/smtp/php.md)
- [Rust](https://local.reloop.sh/docs/examples/smtp/rust.md)

## Integration

- [Integrations](https://local.reloop.sh/docs/integrations.md)
- [n8n](https://local.reloop.sh/docs/integrations/n8n.md)
- [Make.com](https://local.reloop.sh/docs/integrations/make.md)
- [Zapier](https://local.reloop.sh/docs/integrations/zapier.md)
- [WordPress](https://local.reloop.sh/docs/integrations/wordpress.md)
- [Ghost CMS](https://local.reloop.sh/docs/integrations/ghost.md)
- [Strapi](https://local.reloop.sh/docs/integrations/strapi.md)
- [Directus](https://local.reloop.sh/docs/integrations/directus.md)
- [Vercel](https://local.reloop.sh/docs/integrations/vercel.md)
- [Railway](https://local.reloop.sh/docs/integrations/railway.md)
- [Cloudflare](https://local.reloop.sh/docs/integrations/cloudflare.md)
- [Netlify](https://local.reloop.sh/docs/integrations/netlify.md)
- [Docker](https://local.reloop.sh/docs/integrations/docker.md)
- [Coolify](https://local.reloop.sh/docs/integrations/coolify.md)
- [Lovable](https://local.reloop.sh/docs/integrations/lovable.md)
- [Bolt.new](https://local.reloop.sh/docs/integrations/bolt.md)
- [v0](https://local.reloop.sh/docs/integrations/v0.md)
- [Replit](https://local.reloop.sh/docs/integrations/replit.md)
- [Cursor](https://local.reloop.sh/docs/integrations/cursor.md)
- [Windsurf](https://local.reloop.sh/docs/integrations/windsurf.md)

## Learn

- [Overview](https://local.reloop.sh/docs/learn.md)

### Agent Inbox

- [Introduction](https://local.reloop.sh/docs/learn/agent-inbox.md)
- [Details](https://local.reloop.sh/docs/learn/agent-inbox/details.md)

### Emails

- [Introduction](https://local.reloop.sh/docs/learn/emails.md)
- [Details](https://local.reloop.sh/docs/learn/emails/details.md)

### Metrics

- [Introduction](https://local.reloop.sh/docs/learn/metrics.md)
- [Details](https://local.reloop.sh/docs/learn/metrics/details.md)

### Contacts

- [Contacts](https://local.reloop.sh/docs/learn/contacts.md)
- [Properties](https://local.reloop.sh/docs/learn/contacts/properties.md)
- [Groups](https://local.reloop.sh/docs/learn/contacts/groups.md)
- [Channels](https://local.reloop.sh/docs/learn/contacts/channels.md)

### Templates

- [Introduction](https://local.reloop.sh/docs/learn/templates.md)
- [Details](https://local.reloop.sh/docs/learn/templates/details.md)

### API Keys

- [Introduction](https://local.reloop.sh/docs/learn/api-keys.md)
- [Managing API Keys](https://local.reloop.sh/docs/learn/api-keys/managing-api-keys.md)
- [Security](https://local.reloop.sh/docs/learn/api-keys/details.md)

### Logs

- [Introduction](https://local.reloop.sh/docs/learn/logs.md)
- [Details](https://local.reloop.sh/docs/learn/logs/details.md)

### Domain

- [Introduction](https://local.reloop.sh/docs/learn/domain.md)
- [Details](https://local.reloop.sh/docs/learn/domain/details.md)

### Webhooks

- [Introduction](https://local.reloop.sh/docs/learn/webhooks.md)
- [Details](https://local.reloop.sh/docs/learn/webhooks/details.md)

### Workflows

- [Introduction](https://local.reloop.sh/docs/learn/workflows.md)
- [Details](https://local.reloop.sh/docs/learn/workflows/details.md)

### Settings

- [Introduction](https://local.reloop.sh/docs/learn/settings.md)
- [Details](https://local.reloop.sh/docs/learn/settings/details.md)

## Resources

- [SDKs](https://local.reloop.sh/docs/resources/sdks.md)
- [CLI](https://local.reloop.sh/docs/resources/cli.md)
- [Security](https://local.reloop.sh/docs/resources/security.md)

## API Reference


### Overview

- [Introduction](https://local.reloop.sh/docs/api.md)
- [Pagination](https://local.reloop.sh/docs/api/pagination.md)
- [Usage Limits](https://local.reloop.sh/docs/api/usage-limits.md)
- [Errors](https://local.reloop.sh/docs/api/errors.md)

### Sending

- [Send email](https://local.reloop.sh/docs/api/mail/post-api-mail-v1send.md)

### Receiving


#### Mailboxes

- [List Mailboxes](https://local.reloop.sh/docs/api/inbox/mailboxes/get-api-inbox-v1mailboxes-list.md)
- [Get Mailbox](https://local.reloop.sh/docs/api/inbox/mailboxes/get-api-inbox-v1mailboxes-by-id.md)
- [Update Mailbox](https://local.reloop.sh/docs/api/inbox/mailboxes/patch-api-inbox-v1mailboxes-by-id.md)
- [Delete Mailbox](https://local.reloop.sh/docs/api/inbox/mailboxes/delete-api-inbox-v1mailboxes-by-id.md)
- [Create Mailbox](https://local.reloop.sh/docs/api/inbox/mailboxes/post-api-inbox-v1mailboxes-create.md)

#### Messages

- [List Messages](https://local.reloop.sh/docs/api/inbox/messages/get-api-inbox-v1messages.md)
- [Get Message](https://local.reloop.sh/docs/api/inbox/messages/get-api-inbox-v1messages-by-id.md)
- [Update Message Status](https://local.reloop.sh/docs/api/inbox/messages/patch-api-inbox-v1messages-by-id.md)
- [Delete Message](https://local.reloop.sh/docs/api/inbox/messages/delete-api-inbox-v1messages-by-id.md)
- [Batch Get Messages](https://local.reloop.sh/docs/api/inbox/messages/post-api-inbox-v1messages-batch.md)
- [Get Message Attachment](https://local.reloop.sh/docs/api/inbox/messages/get-api-inbox-v1messages-by-id-attachments-by-attachment-id.md)
- [Get Raw Message](https://local.reloop.sh/docs/api/inbox/messages/get-api-inbox-v1messages-by-id-raw.md)
- [Mark Message Read](https://local.reloop.sh/docs/api/inbox/messages/patch-api-inbox-v1messages-by-id-read.md)
- [Toggle Message Star](https://local.reloop.sh/docs/api/inbox/messages/patch-api-inbox-v1messages-by-id-star.md)
- [Send Email](https://local.reloop.sh/docs/api/inbox/messages/post-api-inbox-v1messages-send.md)
- [Reply to Message](https://local.reloop.sh/docs/api/inbox/messages/post-api-inbox-v1messages-by-id-reply.md)
- [Reply All to Message](https://local.reloop.sh/docs/api/inbox/messages/post-api-inbox-v1messages-by-id-reply-all.md)
- [Forward Message](https://local.reloop.sh/docs/api/inbox/messages/post-api-inbox-v1messages-by-id-forward.md)

#### Threads

- [List Threads](https://local.reloop.sh/docs/api/inbox/threads/get-api-inbox-v1threads.md)
- [Get Thread](https://local.reloop.sh/docs/api/inbox/threads/get-api-inbox-v1threads-by-id.md)
- [Update Thread](https://local.reloop.sh/docs/api/inbox/threads/patch-api-inbox-v1threads-by-id.md)
- [Delete Thread](https://local.reloop.sh/docs/api/inbox/threads/delete-api-inbox-v1threads-by-id.md)
- [Get Thread Attachment](https://local.reloop.sh/docs/api/inbox/threads/get-api-inbox-v1threads-by-id-attachments-by-attachment-id.md)
- [Mark Thread Read](https://local.reloop.sh/docs/api/inbox/threads/patch-api-inbox-v1threads-by-id-read.md)
- [Toggle Thread Star](https://local.reloop.sh/docs/api/inbox/threads/patch-api-inbox-v1threads-by-id-star.md)
- [Archive Thread](https://local.reloop.sh/docs/api/inbox/threads/post-api-inbox-v1threads-by-id-archive.md)

### Domain

- [Create Domain](https://local.reloop.sh/docs/api/domain/post-api-domain-v1create.md)
- [Domain Nameservers](https://local.reloop.sh/docs/api/domain/get-api-domain-v1nameservers-by-domain_id.md)
- [Retrieve Domain](https://local.reloop.sh/docs/api/domain/get-api-domain-v1by-domain_id.md)
- [Update domain](https://local.reloop.sh/docs/api/domain/patch-api-domain-v1by-domain_id.md)
- [Delete Domain](https://local.reloop.sh/docs/api/domain/delete-api-domain-v1by-domain_id.md)
- [List domains](https://local.reloop.sh/docs/api/domain/get-api-domain-v1list.md)
- [Verify Domain](https://local.reloop.sh/docs/api/domain/post-api-domain-v1verify-by-domain_id.md)
- [Forward DNS Records](https://local.reloop.sh/docs/api/domain/post-api-domain-v1verify-by-domain_id-forward-dns.md)

### API Key

- [Create API Key](https://local.reloop.sh/docs/api/api-key/post-api-api-key-v1.md)
- [List API keys](https://local.reloop.sh/docs/api/api-key/get-api-api-key-v1.md)
- [Retrieve API key](https://local.reloop.sh/docs/api/api-key/get-api-api-key-v1by-api_key_id.md)
- [Update API key](https://local.reloop.sh/docs/api/api-key/patch-api-api-key-v1by-api_key_id.md)
- [Delete API key](https://local.reloop.sh/docs/api/api-key/delete-api-api-key-v1by-api_key_id.md)
- [Rotate API key](https://local.reloop.sh/docs/api/api-key/post-api-api-key-v1rotate-by-api_key_id.md)
- [Enable API key](https://local.reloop.sh/docs/api/api-key/post-api-api-key-v1enable-by-api_key_id.md)
- [Disable API key](https://local.reloop.sh/docs/api/api-key/post-api-api-key-v1disable-by-api_key_id.md)

### Webhooks

- [Create webhook](https://local.reloop.sh/docs/api/webhook/post-api-webhook-v1.md)
- [List webhooks](https://local.reloop.sh/docs/api/webhook/get-api-webhook-v1.md)
- [Retrieves webhook](https://local.reloop.sh/docs/api/webhook/get-api-webhook-v1by-webhook_id.md)
- [Update webhook](https://local.reloop.sh/docs/api/webhook/patch-api-webhook-v1by-webhook_id.md)
- [Delete webhook](https://local.reloop.sh/docs/api/webhook/delete-api-webhook-v1by-id.md)
- [Trigger webhooks](https://local.reloop.sh/docs/api/webhook/post-api-webhook-v1trigger.md)
- [List webhook deliveries](https://local.reloop.sh/docs/api/webhook/get-api-webhook-v1by-webhook_id-deliveries.md)
- [Retry webhook delivery](https://local.reloop.sh/docs/api/webhook/post-api-webhook-deliveries-by-delivery_id-retry.md)

### Contacts

- [Create Contact](https://local.reloop.sh/docs/api/contacts/post-api-contacts-create.md)
- [Retrieve Contact](https://local.reloop.sh/docs/api/contacts/get-api-contacts-retrieve-by-contact_id.md)
- [List Contacts](https://local.reloop.sh/docs/api/contacts/get-api-contacts-list.md)
- [Update Contact](https://local.reloop.sh/docs/api/contacts/patch-api-contacts-by-contact_id.md)
- [Delete Contact](https://local.reloop.sh/docs/api/contacts/delete-api-contacts-by-contact_id.md)
- [Add Contact Channel](https://local.reloop.sh/docs/api/contacts/post-api-contacts-channel-by-channel_id.md)
- [Update Contact Channel](https://local.reloop.sh/docs/api/contacts/patch-api-contacts-channel-by-channel_id.md)
- [Add Contact Group](https://local.reloop.sh/docs/api/contacts/post-api-contacts-group-by-group_id.md)
- [Delete Contact Group](https://local.reloop.sh/docs/api/contacts/delete-api-contacts-group-by-group_id.md)

#### Contact Properties

- [Create Contact Property](https://local.reloop.sh/docs/api/contacts/contact-properties/post-api-contacts-v1properties-create.md)
- [List Contact Properties](https://local.reloop.sh/docs/api/contacts/contact-properties/get-api-contacts-v1properties-list.md)
- [Update Contact Property](https://local.reloop.sh/docs/api/contacts/contact-properties/patch-api-contacts-v1properties-by-contact_property_id.md)
- [Delete Contact Property](https://local.reloop.sh/docs/api/contacts/contact-properties/delete-api-contacts-v1properties-by-contact_property_id.md)

#### Channels

- [Create Channel](https://local.reloop.sh/docs/api/contacts/channels/post-api-contacts-v1channels-create.md)
- [Retrieve Channel](https://local.reloop.sh/docs/api/contacts/channels/get-api-contacts-v1channels-by-channel_id.md)
- [Update Channel](https://local.reloop.sh/docs/api/contacts/channels/patch-api-contacts-v1channels-by-channel_id.md)
- [Delete Channel](https://local.reloop.sh/docs/api/contacts/channels/delete-api-contacts-v1channels-by-channel_id.md)
- [List Channels](https://local.reloop.sh/docs/api/contacts/channels/get-api-contacts-v1channels-list.md)

#### Groups

- [Create Group](https://local.reloop.sh/docs/api/contacts/groups/post-api-contacts-v1groups-create.md)
- [Retrieve Group](https://local.reloop.sh/docs/api/contacts/groups/get-api-contacts-v1groups-by-group_id.md)
- [Update Group](https://local.reloop.sh/docs/api/contacts/groups/patch-api-contacts-v1groups-by-group_id.md)
- [Delete Group](https://local.reloop.sh/docs/api/contacts/groups/delete-api-contacts-v1groups-by-group_id.md)
- [List Groups](https://local.reloop.sh/docs/api/contacts/groups/get-api-contacts-v1groups-list.md)
- [List Contacts in Group](https://local.reloop.sh/docs/api/contacts/groups/get-api-contacts-v1groups-by-group_id-contacts.md)

### Logs

- [List Logs](https://local.reloop.sh/docs/api/logs/get-api-logs-v1list.md)
- [Get Log](https://local.reloop.sh/docs/api/logs/get-api-logs-v1by-log_id.md)
- [List Email Logs](https://local.reloop.sh/docs/api/logs/get-api-logs-v1emails.md)
- [Get Contact Email Activity](https://local.reloop.sh/docs/api/logs/get-api-logs-v1emails-contact-activity.md)
- [Get Email Log Details](https://local.reloop.sh/docs/api/logs/get-api-logs-v1emails-by-id.md)
- [Get Email Stats](https://local.reloop.sh/docs/api/logs/get-api-logs-v1emails-stats.md)

### Upload

- [Upload an image file](https://local.reloop.sh/docs/api/upload/post-api-upload-v1upload.md)
- [Delete an uploaded file](https://local.reloop.sh/docs/api/upload/delete-api-upload-v1files-by-file-id.md)

### Templates

- [Create a new template](https://local.reloop.sh/docs/api/template/post-api-template-v1create.md)
- [Create a new template version](https://local.reloop.sh/docs/api/template/post-api-template-v1by-id-versions.md)
- [List Template](https://local.reloop.sh/docs/api/template/get-api-template-v1by-id-versions.md)
- [Delete template version](https://local.reloop.sh/docs/api/template/delete-api-template-v1by-id-versions-by-version-id.md)
- [Restore template version](https://local.reloop.sh/docs/api/template/post-api-template-v1by-id-versions-by-version-id-restore.md)
- [Get template by ID](https://local.reloop.sh/docs/api/template/get-api-template-v1by-id.md)
- [Update template](https://local.reloop.sh/docs/api/template/put-api-template-v1by-id.md)
- [Delete template](https://local.reloop.sh/docs/api/template/delete-api-template-v1by-id.md)
- [List templates](https://local.reloop.sh/docs/api/template/get-api-template-v1list.md)
- [Duplicate template](https://local.reloop.sh/docs/api/template/post-api-template-v1by-id-duplicate.md)
- [Send test email](https://local.reloop.sh/docs/api/template/post-api-template-v1by-id-test.md)

## Webhooks


### Webhooks

- [Introduction](https://local.reloop.sh/docs/webhooks.md)
- [Event Types](https://local.reloop.sh/docs/webhooks/event-types.md)
- [Retries and Replays](https://local.reloop.sh/docs/webhooks/retries-and-replays.md)
- [Verify Webhooks Requests](https://local.reloop.sh/docs/webhooks/verify-webhooks-requests.md)
- [Webhook Ingester](https://local.reloop.sh/docs/webhooks/ingester.md)

### Emails

- [email.bounced](https://local.reloop.sh/docs/webhooks/emails/bounced.md)
- [email.clicked](https://local.reloop.sh/docs/webhooks/emails/clicked.md)
- [email.complained](https://local.reloop.sh/docs/webhooks/emails/complained.md)
- [email.delivered](https://local.reloop.sh/docs/webhooks/emails/delivered.md)
- [email.delivery_delayed](https://local.reloop.sh/docs/webhooks/emails/delivery-delayed.md)
- [email.failed](https://local.reloop.sh/docs/webhooks/emails/failed.md)
- [email.opened](https://local.reloop.sh/docs/webhooks/emails/opened.md)
- [email.received](https://local.reloop.sh/docs/webhooks/emails/received.md)
- [email.scheduled](https://local.reloop.sh/docs/webhooks/emails/scheduled.md)
- [email.sent](https://local.reloop.sh/docs/webhooks/emails/sent.md)
- [email.suppressed](https://local.reloop.sh/docs/webhooks/emails/suppressed.md)

### Domains

- [domain.created](https://local.reloop.sh/docs/webhooks/domains/created.md)
- [domain.updated](https://local.reloop.sh/docs/webhooks/domains/updated.md)
- [domain.deleted](https://local.reloop.sh/docs/webhooks/domains/deleted.md)

### Contacts

- [contact.created](https://local.reloop.sh/docs/webhooks/contacts/created.md)
- [contact.updated](https://local.reloop.sh/docs/webhooks/contacts/updated.md)
- [contact.deleted](https://local.reloop.sh/docs/webhooks/contacts/deleted.md)

## Self-Hosted


### Overview

- [Introduction](https://local.reloop.sh/docs/self-host.md)
- [Requirements](https://local.reloop.sh/docs/self-host/requirements.md)
- [Services](https://local.reloop.sh/docs/self-host/services.md)

### Cloud Providers

- [Deploy on Coolify](https://local.reloop.sh/docs/self-host/coolify.md)
- [Deploy on Dokploy](https://local.reloop.sh/docs/self-host/dokploy.md)
- [Deploy on VPS](https://local.reloop.sh/docs/self-host/vps.md)
- [Deploy on Vercel](https://local.reloop.sh/docs/self-host/vercel.md)
- [Deploy on Railway](https://local.reloop.sh/docs/self-host/railway.md)
- [Deploy on Azure](https://local.reloop.sh/docs/self-host/azure.md)
- [Deploy on Cloudflare](https://local.reloop.sh/docs/self-host/cloudflare.md)
- [Deploy on Netlify](https://local.reloop.sh/docs/self-host/netlify.md)

## Setup


### Introduction

- [Overview](https://local.reloop.sh/docs/setup/overview.md)
- [Setup](https://local.reloop.sh/docs/setup.md)
- [Port](https://local.reloop.sh/docs/setup/port.md)

### Frontend

- [Web](https://local.reloop.sh/docs/setup/frontend/web.md)
- [Dashboard](https://local.reloop.sh/docs/setup/frontend/dashboard.md)
- [Docs](https://local.reloop.sh/docs/setup/frontend/docs.md)
- [Links](https://local.reloop.sh/docs/setup/frontend/links.md)

### Backend

- [Auth](https://local.reloop.sh/docs/setup/backend/auth.md)
- [Domain](https://local.reloop.sh/docs/setup/backend/domain.md)
- [API Key](https://local.reloop.sh/docs/setup/backend/api-key.md)
- [Webhook](https://local.reloop.sh/docs/setup/backend/webhook.md)
- [Contacts](https://local.reloop.sh/docs/setup/backend/contacts.md)
- [Mail](https://local.reloop.sh/docs/setup/backend/mail.md)
- [Logs](https://local.reloop.sh/docs/setup/backend/logs.md)
- [Workflow](https://local.reloop.sh/docs/setup/backend/workflow.md)
- [Upload](https://local.reloop.sh/docs/setup/backend/upload.md)
- [Template](https://local.reloop.sh/docs/setup/backend/template.md)
- [Inbox](https://local.reloop.sh/docs/setup/backend/inbox.md)
- [Email](https://local.reloop.sh/docs/setup/backend/email.md)
- [Credits](https://local.reloop.sh/docs/setup/backend/credits.md)
- [SMTP](https://local.reloop.sh/docs/setup/backend/smtp.md)
- [Inbound](https://local.reloop.sh/docs/setup/backend/inbound.md)
- [Spam](https://local.reloop.sh/docs/setup/backend/spam.md)
