API Setup

The API channel allows you to create a custom integration using the Evo CRM API to connect external systems and custom applications. This channel offers flexibility for custom integrations through REST endpoints.

---

​

Starting a New Channel

To start creating an API channel, use the highlighted action on the Channels screen. The New Channel button (highlighted) is used to start creating a new communication channel.

---

​

Selecting API

On the Select a channel type screen, click the API card. The highlighted card represents the custom API integration.

---

​

Configuring the API Channel

After selecting API, the Configure Channel screen is displayed. Within the highlighted area, the screen shows:

​

Channel Identification

• API
• Description: “Custom API integration”

​

Channel Information

• Display Name *
  • Friendly name for identification
  • Example: “API Support”
• Channel Name *
  • Channel name (automatically generated)
  • Example: “api-support”

​

Webhook Configuration

• Webhook URL
  • URL where events will be sent
  • Example: “https://your-api.com/webhook”
  • Optional field

​

API Channel Information

The screen displays an information box with:

• API Channel: Custom integration via REST API
• Webhook URL: Optional - URL to receive real-time events
• Documentation: Consult the API documentation for implementation

​

Action Buttons

• Cancel
  • Discards the configuration
• Create Channel
  • Saves and activates the API Channel

After filling in the necessary fields, click Create Channel to finalize the configuration.

---

​

Final Considerations

• The API channel requires technical knowledge for configuration
• The Webhook URL is optional but recommended for receiving real-time events
• API credentials must be kept secure
• Consult the API documentation for implementation details
• Once configured, the channel allows integration with external systems through REST endpoints