Skip to main content

Development Guide

Welcome to the Development Guide for Wazo plugins. This guide is designed to help you navigate the process of developing a Wazo plugin, from initial setup to deployment.

If you're new to Wazo, you might want to familiarize yourself with its architecture and concepts before diving into plugin development. For a comprehensive understanding of Wazo, check out the our API documentation.

During development​

Developers can install a plugin from a localhost environment. Example the manifest URL could be https://localhost:3000/manifest.json. Just keep in mind not to install it for a real client, as users will not be able to load a plugin from a localhost environment.

CORS need to be configured to be able to install a local plugin. The process to install a local vs production plugin is the same, please refer to the distributing section.

Mobile Development​

When developing a plugin for the mobile application, developers needs to use secure tunnel to expose localhost environment to a public URL. At Wazo, we use ngrok during development phase. ngrok is a easy to use CLI and fits perfectly mobile developments needs. Here's a few steps

  • Create an account on ngrok
  • Install and configure ngrok CLI
  • Be sure you local server is started: http://localhost:3000
  • Proxy you local server why ngrok: ngrok http http://localhost:3000
  • From Portal, install plugin with the forwarding URL provided by ngrok: https://<forwarding-url>.ngrok-free.dev/manifest.json