Table of Contents

1. Introduction
2. Understanding Native Integrations
3. Creating an Integration
4. Integration Form Details
5. Creating a Product Integration
6. After Integration Creation
7. Viewing and Managing Integrations
8. Connectable Account Integrations
9. Community Badge and Community Integrations
10. Installation Flow Best Practices
11. Integration Support
12. Conclusion

---

Introduction

Integrating with Esadax offers a powerful way to enhance your application or service. Whether you're building for internal use or publishing a tool for others, this guide will walk you through every step of creating, managing, and optimizing your integration — with best practices to ensure a smooth experience for your users.

---

Understanding Native Integrations

Native integrations are first-class citizens in the Esadax ecosystem, offering direct and seamless integration with platform features.

Key benefits:

• No middleware required — Native support from within the Esadax platform.
• Reduced development time — Prebuilt components and simplified setup.
• Stronger developer experience — Full documentation and platform support.

You may also choose to build Custom integrations if your use case requires external services or APIs.

---

Creating an Integration

To get started:

1. Go to the Integrations Console.
2. Click Create Integration.
3. Fill out the form with your integration's basic info (see next section).

---

Integration Form Details

When filling out the integration form, provide:

• Name: A unique identifier for your integration.
• Description: A short explanation of what your integration does.
• Integration Type: Choose between “Native” and “Custom.”
• Visibility Settings: Define who can see or use the integration.
• Support Email: Provide contact details for support.
• Documentation Link (optional): Help users understand how to install and use it.
• Deploy Button (optional): Add a button to auto-deploy the integration from Git.

---

Creating a Product Integration

When your integration involves an installable product, you should:

• Provide a clear installation flow that accommodates both new and existing users.
• Include concise documentation for installation and usage.
• Define default settings that work out of the box while still allowing customization.
• Use versioning in your form to help track updates and backward compatibility.

---

After Integration Creation

Once published, you can:

• Monitor logs using the View Logs button in the Integrations Console.
• Update status: Track installation metrics, errors, and version changes.
• Refine your integration: Iterate based on user feedback or testing.

---

Viewing and Managing Integrations

In the Integrations Console, you can:

• View a list of your integrations.
• Access details, including live URLs, install logs, and visibility status.
• Filter logs by request type (e.g., errors, installations).

---

Connectable Account Integrations

If your integration connects external services (e.g., analytics, authentication, ecommerce):

• Enable secure account linking workflows.
• Support multi-account scenarios (individual vs. org).
• Validate tokens and identities per Esadax’s shared security model.

---

Community Badge and Community Integrations

• Integrations submitted by external developers receive a Community badge, marking them as third-party supported.
• These may appear in the marketplace with a clear label.
• Before installing a community integration, users should review the developer’s:
  • Privacy Policy
  • Terms of Use
  • Support details

---

Installation Flow Best Practices

Designing an intuitive installation experience improves adoption.

Recommended Flow:

• New Users:
  • Guide through account creation within the installation process.
• Returning Users:
  • Allow seamless sign-in without losing installation progress.
• Error Recovery:
  • Gracefully handle password resets and expired sessions.
• Defaults:
  • Preconfigure sensible settings to minimize required input.
• Advanced Options:
  • Provide them, but tuck them behind a toggle or expandable section.

---

Integration Support

You're responsible for ongoing support of your integration:

• Respond promptly to issues via your support email.
• Include troubleshooting tips and known limitations in your documentation.
• Consider setting up versioned changelogs to communicate updates clearly.

---

Conclusion

By following this guide, you can deliver a reliable and user-friendly integration for the Esadax platform. Whether you're extending internal workflows or building tools for the community, thoughtful integration design — from form structure to user flow — ensures your work is successful and scalable.

---