# Nexiom Connect

> Nexiom Connect is an email and WhatsApp API for developers: verify a sending domain, send transactional email, manage contacts, send WhatsApp template messages from your own business number, and receive delivery webhooks.

Every page is available as Markdown by appending `.md` to its URL. The complete documentation is at https://connect.nxiom.com/docs/llms-full.txt.

## Documentation

- [Introduction](https://connect.nxiom.com/docs.md): Nexiom Connect is the email and WhatsApp API for developers. Send transactional email and WhatsApp messages, and follow every delivery.
- [Quickstart](https://connect.nxiom.com/docs/quickstart.md): Verify a sending domain, create an API key, and send your first email.
- [API keys](https://connect.nxiom.com/docs/learn/api-keys.md): Create API keys with the least access they need, restrict them to a domain, and rotate them safely.
- [Domains](https://connect.nxiom.com/docs/learn/domains.md): Add a sending domain, publish its DNS records, and understand verification and domain status.
- [Connect a domain](https://connect.nxiom.com/docs/learn/connect-domain.md): Choose a sending subdomain, publish its DNS records, and verify it — start to finish.
- [DNS provider setup](https://connect.nxiom.com/docs/learn/dns-providers.md): Step-by-step instructions for adding your sending domain's records at popular DNS providers.
- [Domain not verifying](https://connect.nxiom.com/docs/learn/domain-not-verifying.md): Find the DNS record that's holding verification back, and fix the most common mistakes.
- [Sending email](https://connect.nxiom.com/docs/learn/sending.md): Compose transactional email, address recipients, use templates, and retry safely with idempotency keys.
- [Templates](https://connect.nxiom.com/docs/learn/templates.md): Design an email once, publish it, and send it by ID with your own values.
- [Email activity](https://connect.nxiom.com/docs/learn/email-activity.md): Follow each delivery from queued to delivered, understand every status, and read engagement.
- [Contacts](https://connect.nxiom.com/docs/learn/contacts.md): Keep a record of the people you email, with custom properties and subscription status.
- [Deliverability](https://connect.nxiom.com/docs/learn/deliverability.md): Reach the inbox, not the spam folder — authentication, content, list hygiene, and reputation.
- [Retry safely](https://connect.nxiom.com/docs/learn/retry-safely.md): Handle timeouts, rate limits, and server errors without ever sending the same email twice.
- [Production checklist](https://connect.nxiom.com/docs/learn/production-checklist.md): Confirm your domain, keys, error handling, and monitoring before you send to real users.
- [WhatsApp](https://connect.nxiom.com/docs/whatsapp.md): Send WhatsApp template messages from your own business number, and follow each one from sent to read.
- [WhatsApp quickstart](https://connect.nxiom.com/docs/whatsapp/quickstart.md): Connect your WhatsApp number, get a template approved, and send your first WhatsApp message with the API.
- [WhatsApp key concepts](https://connect.nxiom.com/docs/whatsapp/key-concepts.md): The accounts, reviews, and limits that shape WhatsApp business messaging, and which of them Meta controls.
- [Connect a WhatsApp number](https://connect.nxiom.com/docs/whatsapp/senders.md): Prepare a phone number, connect it through Meta's signup window, and manage its display name, profile, and health.
- [WhatsApp templates](https://connect.nxiom.com/docs/whatsapp/templates.md): Create message templates, get them approved by WhatsApp, and fill in their variables when you send.
- [Sending WhatsApp messages](https://connect.nxiom.com/docs/whatsapp/sending.md): Send template messages safely, follow their statuses, and understand costs, limits, and retention.
- [WhatsApp best practices and FAQ](https://connect.nxiom.com/docs/whatsapp/best-practices.md): Keep your number healthy, understand WhatsApp's failure codes, and check everything before you go live.
- [Node.js SDK](https://connect.nxiom.com/docs/examples/nodejs.md): Send email and manage contacts from Node.js with the official, fully typed Nexiom Connect SDK.
- [PHP SDK](https://connect.nxiom.com/docs/examples/php.md): Send email and manage contacts from PHP with the official Nexiom Connect SDK.

## API Reference

- [API reference](https://connect.nxiom.com/docs/api.md): Everything you need to connect your application to the Nexiom Connect API.
- [Pagination](https://connect.nxiom.com/docs/api/pagination.md): Move through domain collections and email activity without losing your place.
- [Usage limits](https://connect.nxiom.com/docs/api/usage-limits.md): Understand request limits, email and WhatsApp allowances, and how to recover when you reach them.
- [Errors](https://connect.nxiom.com/docs/api/errors.md): Identify failed requests and choose the right recovery action.
- [Send an email](https://connect.nxiom.com/docs/api/emails/send.md): Send transactional email from a verified domain with an idempotent request.
- [List emails](https://connect.nxiom.com/docs/api/emails/list.md): Browse delivery logs with cursor pagination and focused filters.
- [Retrieve an email](https://connect.nxiom.com/docs/api/emails/retrieve.md): Inspect one recipient delivery, its content, and its delivery and engagement history.
- [Reschedule an email](https://connect.nxiom.com/docs/api/emails/reschedule.md): Move a scheduled email to a new send time, up to 30 days after it was created.
- [Cancel a scheduled email](https://connect.nxiom.com/docs/api/emails/cancel.md): Stop a scheduled email before its send time. Nothing is sent or charged.
- [List suppressions](https://connect.nxiom.com/docs/api/emails/suppressions.md): See which addresses your project does not send to, and why.
- [List templates](https://connect.nxiom.com/docs/api/templates/list.md): Find templates by name, status, origin, or category.
- [Retrieve a template](https://connect.nxiom.com/docs/api/templates/retrieve.md): Read a template with its draft and published versions and their variables.
- [List template variables](https://connect.nxiom.com/docs/api/templates/variables.md): Read the variables of the template version being edited.
- [List template versions](https://connect.nxiom.com/docs/api/templates/versions.md): Read the saved and published versions of a template, newest first.
- [Create a domain](https://connect.nxiom.com/docs/api/email-domains/create.md): Add a sending subdomain and get it ready for DNS verification.
- [Retrieve a domain](https://connect.nxiom.com/docs/api/email-domains/retrieve.md): Retrieve the status and DNS verification details for a sending domain.
- [List domains](https://connect.nxiom.com/docs/api/email-domains/list.md): Find sending domains in your project, with search and pagination.
- [Verify a domain](https://connect.nxiom.com/docs/api/email-domains/verify.md): Check the DNS records published for your sending domain.
- [Delete a domain](https://connect.nxiom.com/docs/api/email-domains/delete.md): Remove a sending domain from your project.
- [Create a contact](https://connect.nxiom.com/docs/api/contacts/create.md): Add a person to your project, with optional profile fields and custom properties.
- [Retrieve a contact](https://connect.nxiom.com/docs/api/contacts/retrieve.md): Get one contact with its properties, email statistics, list memberships, and recent activity.
- [List contacts](https://connect.nxiom.com/docs/api/contacts/list.md): Page through your contacts, with search and filters for subscription status, list, and segment.
- [Update a contact](https://connect.nxiom.com/docs/api/contacts/update.md): Change a contact's profile, custom properties, or subscription status.
- [Delete a contact](https://connect.nxiom.com/docs/api/contacts/delete.md): Remove a contact from your project.
- [Send a message](https://connect.nxiom.com/docs/api/messaging/send.md): Send a message on a messaging channel, such as an approved WhatsApp template, with an idempotent request.
- [Retrieve a message](https://connect.nxiom.com/docs/api/messaging/retrieve.md): Read one message, on any channel, with its current status, cost, failure details, and the content the recipient received.

## Webhooks

- [Webhooks](https://connect.nxiom.com/docs/webhooks.md): Receive signed events when email delivery, contact activity, and WhatsApp messages change.
- [Event types](https://connect.nxiom.com/docs/webhooks/event-types.md): Choose the email, contact, and WhatsApp events your application needs.
- [Verify webhook requests](https://connect.nxiom.com/docs/webhooks/verify-webhooks-requests.md): Confirm that every event comes from Nexiom Connect with one SDK call, and get a typed event back.
- [Retries and replays](https://connect.nxiom.com/docs/webhooks/retries-and-replays.md): Recover failed deliveries while keeping your event processing safe to repeat.
- [Webhook ingester](https://connect.nxiom.com/docs/webhooks/ingester.md): Build a small, reliable receiver that accepts events before processing them.
- [email.scheduled](https://connect.nxiom.com/docs/webhooks/emails/scheduled.md): An email was scheduled for a later send time, or rescheduled.
- [email.canceled](https://connect.nxiom.com/docs/webhooks/emails/canceled.md): A scheduled email was canceled before its send time.
- [email.sent](https://connect.nxiom.com/docs/webhooks/emails/sent.md): The sending provider accepted the email.
- [email.delivered](https://connect.nxiom.com/docs/webhooks/emails/delivered.md): The receiving mail server accepted the email.
- [email.delivery_delayed](https://connect.nxiom.com/docs/webhooks/emails/delivery-delayed.md): The provider reported a temporary delivery delay.
- [email.bounced](https://connect.nxiom.com/docs/webhooks/emails/bounced.md): A recipient delivery permanently bounced.
- [email.complained](https://connect.nxiom.com/docs/webhooks/emails/complained.md): A recipient reported an email as spam.
- [email.failed](https://connect.nxiom.com/docs/webhooks/emails/failed.md): The email reached a final send failure.
- [email.opened](https://connect.nxiom.com/docs/webhooks/emails/opened.md): An email open was recorded.
- [email.clicked](https://connect.nxiom.com/docs/webhooks/emails/clicked.md): A recipient clicked a tracked link.
- [contact.created](https://connect.nxiom.com/docs/webhooks/contacts/created.md): A contact was created.
- [contact.updated](https://connect.nxiom.com/docs/webhooks/contacts/updated.md): A contact was updated.
- [contact.unsubscribed](https://connect.nxiom.com/docs/webhooks/contacts/unsubscribed.md): A contact changed to unsubscribed.
- [contact.deleted](https://connect.nxiom.com/docs/webhooks/contacts/deleted.md): A contact was deleted.
- [whatsapp.message.sent](https://connect.nxiom.com/docs/webhooks/whatsapp/sent.md): WhatsApp sent a message to the recipient's phone.
- [whatsapp.message.delivered](https://connect.nxiom.com/docs/webhooks/whatsapp/delivered.md): A WhatsApp message reached the recipient's phone.
- [whatsapp.message.read](https://connect.nxiom.com/docs/webhooks/whatsapp/read.md): The recipient opened a WhatsApp message.
- [whatsapp.message.failed](https://connect.nxiom.com/docs/webhooks/whatsapp/failed.md): A WhatsApp message could not be sent or delivered.