Documentation

1. Getting Started

Callout Guardian ships with built-in documentation accessible directly within your Salesforce org after installation. Once the managed package is installed, all guides and reference materials are available as Static Resources, ensuring you always have the documentation that matches your installed version.

2. In-App Documentation

Two comprehensive guides are included as Static Resources in the package:

2.1 Admin Guide

The Admin Guide covers everything you need to set up and manage Callout Guardian:

• Installation and initial configuration
• Permission Sets assignment (Admin, Viewer, Alert Recipient, API User)
• Custom Metadata Type setup and configuration
• Scheduling health checks and configuring check intervals
• Alert channels setup (Chatter, Email, Custom Channels)
• Dashboard customization and navigation
• Data retention policies and batch job management

2.2 Developer Guide

The Developer Guide provides API reference and extension points for developers:

• Global Classes:
  • CalloutGuardian — Main entry point for protected callouts with circuit breaker, retry, and timeout logic
  • CalloutOptions — Configuration builder for callout behavior (timeout, retries, circuit breaker thresholds)
  • GuardianResponse — Wrapper for callout results including status, response data, and error classification
• Extension Interfaces:
  • IScanner — Implement custom endpoint discovery sources
  • IAlertChannel — Build custom alert delivery channels (Slack, Teams, PagerDuty, etc.)
  • IErrorClassifier — Extend error classification with custom patterns specific to your integrations
• REST API reference for external integrations
• Webhook subscription and payload format documentation

3. Key Features

Callout Guardian provides a comprehensive suite of tools for Salesforce integration monitoring:

• Endpoint Health Monitoring — Configurable schedules with HTTP HEAD/GET probes and automatic error classification across 17 error patterns
• Circuit Breaker Pattern — Automatic protection against failing endpoints with configurable thresholds, cooldown periods, and half-open recovery
• Real-Time Alerting — Multi-channel notifications via Chatter, Email, and custom channels (IAlertChannel interface)
• Analytics Dashboard — Trend analysis, SLA compliance reporting, and endpoint health visualization
• Brain Engine — Risk assessment and anomaly detection using statistical analysis of callout patterns
• REST API — Full CRUD API for external integrations with HMAC-signed webhook delivery
• Automated Discovery — Discovers endpoints from 8 sources: Named Credentials, Remote Site Settings, CSP Trusted Sites, External Data Sources, External Services, External Credentials, Outbound Messages, and Apex code

4. Support

Support availability depends on your subscription tier. See our Terms of Service (Section 6.2) for detailed SLA response times.

• Free Plan: Community support via documentation and email (best-effort)
• Pro Plan: Email support with 48-hour response time
• Enterprise Plan: Priority email support with 24-hour response time

Contact us at contact@calloutguardian.com for any questions.

Available on the Salesforce AppExchange.

5. Supported Editions

Callout Guardian is compatible with the following Salesforce editions:

• Enterprise Edition
• Developer Edition
• Unlimited Edition

Note: Professional Edition is not supported because Apex is not available on that edition.