Easy 5-Minute Setup

Installation Made Simple

Get your PerfexCRM API & Webhooks module up and running in minutes with our step-by-step guide

No Coding Required
5-Minute Setup
Video Tutorial
Go to Member Portal

Step 1: Get Your Module

Secure download with license verification

1

Login to Member Portal

Access the member area with your license key and email

2

Activate Your Domain

Enter your domain and verify via email (security feature)

3

Download Module

Download the module ZIP file (only works after activation)

Access Member Portal

Secure download protected by email verification (Oct 2025 security update)

System Requirements

Make sure your server meets these requirements

PerfexCRM
2.3.0+
PHP
7.4 - 8.3
MySQL
5.7+
SSL Certificate
Required
cURL
Enabled
JSON
Enabled

Important Notes

  • •SSL Certificate is required for webhook functionality
  • •Tested with PHP 8.3 - fully compatible with modern hosting
  • •Works with PerfexCRM 2.3.0+ (older versions not supported)

Step 2: Install Module

Simple step-by-step installation process

Step 1

Extract Module ZIP

Extract the downloaded ZIP file to access the api_webhooks folder

unzip perfexcrm-api-webhooks.zip
Step 2

Upload to PerfexCRM

Upload the api_webhooks folder to your modules directory

/path/to/perfexcrm/modules/api_webhooks/
Step 3

Set File Permissions

Ensure proper permissions for the module (755 recommended)

chmod -R 755 modules/api_webhooks
chown -R www-data:www-data modules/api_webhooks
Step 4

Activate in PerfexCRM

Go to Setup → Modules and activate "API & Webhooks"

Setup > Modules > Activate
Step 5

Enter License Key

Enter your license key in the module activation page

Required for module functionality
Step 6

Configure API Settings

Navigate to API Settings and customize your preferences

Settings > API & Webhooks

License Activation Required

After activating the module in PerfexCRM, you must enter your license key. The module verifies your license with our Panel API and will not function without a valid license.

Step 3: Configure & Test

Set up your API and verify everything is working

Generate API Key

  • Go to Settings → API & Webhooks
  • Click "Generate New API Key"
  • Copy and save your API key securely
  • Set permissions for API access

Configure Webhooks

  • Navigate to Webhooks tab
  • Add webhook URL for each event
  • Select events to monitor (100+ available)
  • Test webhook delivery

Test API Connection

Try this quick test:

curl -H "X-API-KEY: pk_your_api_key_here" \
https://yoursite.com/api/v1/customers

Import n8n Workflows

  • Pre-built workflows included
  • Import JSON files to n8n
  • Connect to Slack, Email, CRM, etc.
  • Automate your business processes

One-Click Auto-Updates Included

After installation, you will also have access to one-click auto-updates. When new versions are released, navigate to Setup → API & Webhooks → License and click "Check Updates". The module will automatically download, verify, back up your current version, and install the update — no manual file uploads needed.

Common Issues

Quick solutions to common installation problems

Module not appearing?

Check folder location and permissions

Path: /modules/api_webhooks/ Permissions: 755

Database errors?

Clear cache and check PerfexCRM version

rm -rf application/cache/*

License verification failed?

Ensure your server can reach Panel API

  • Check firewall allows outbound HTTPS
  • Verify cURL extension is enabled

Need more help?

Our support team is here to assist you

Contact Support

Ready to Get Started?

Explore our documentation, check out code examples, or start building with our API

View Code ExamplesGet Support
100+
Webhook Events
170+
API Endpoints
19
API Resources