Troubleshooting API, Webhook, and Network Failures

1. Overview & Business Value#

This comprehensive operational guide details the architecture, business workflows, configuration parameters, and execution steps for Troubleshooting API, Webhook, and Network Failures within SmartERP.

Comprehensive troubleshooting reference for identifying and resolving external integration faults.

Common API Exceptions#

1. HTTP 401 Unauthorized: Invalid or revoked API key; verify Bearer header format.
2. Webhook Dropped Callbacks: Target server firewall blocking incoming traffic; check endpoint SSL certificate and port availability.
3. Signature Mismatch on FinTech Callbacks: SHA-256 HMAC payload computed using stale secret key.

{screenshot:troubleshooting-api-and-webhook-errors-overview-dashboard}

2. Prerequisites & Security Access Groups#

• Required Modules: base, web, smarterp_core, payment
• Security Groups:
  • Integration Specialist (Technical ID: base.group_user)
  • System Administrator / API Director (Technical ID: base.group_system)
• Master Data Dependencies: Established API keys, configured payment providers, and verified external webhook callback endpoints.

3. Step-by-Step Configuration & Execution#

Step 1: Navigating to the Module Interface#

1. Log into your SmartERP instance at https://smarterp.et/odoo.
2. Open the main App Switcher (grid icon in the top-left corner).
3. Select the Settings app icon.
4. From the top navigation bar, open Technical → Integrations → API Keys / Webhooks.

{screenshot:troubleshooting-api-and-webhook-errors-app-switcher-navigation}

Step 2: Creating and Parameterizing Records#

1. Click the New button in the top-left control panel.
2. Complete the mandatory fields in the integration form:
   • Endpoint Name (Mandatory): Descriptive identifier for the external client application.
   • Allowed API Scopes (Mandatory): Explicit read/write model permissions.
   • Authentication Mode (Mandatory): Bearer Token, API Key, or HMAC-SHA256 signature.
3. Configure optional parameters: rate limit quotas, IP address allowlists, and retry schedules.

{screenshot:troubleshooting-api-and-webhook-errors-record-creation-form}

Step 3: Validating and Processing Transactions#

• Execution & Validation: Dispatch test payload from external client tool (cURL / Postman).
• Log Verification: Inspect HTTP response status (HTTP 200 OK) in the API access log.

{screenshot:troubleshooting-api-and-webhook-errors-transaction-processing-state}

4. Advanced Configuration Points#

• Automated Actions & Scheduled Tasks (Crons):
  • Integration: Clean stale webhook queues (base.ir_cron_webhook_cleanup)
  • Integration: Sync currency exchange rates (base.ir_cron_currency_rates)
• Custom Print Templates & Reports:
  • API Usage & Latency Telemetry Audit Report
  • FinTech Reconciliation & Settlement Statement
• Multi-Company Rules: Record-level security isolation under Company 1 (Ashewa Technology Solutions S.C.).

5. Comprehensive Troubleshooting Matrix#