Skip to main content

​
Overview

The Developer Tools section provides everything you need to integrate and manage your API usage in one place. You can:
  • Generate and manage API keys
  • Configure webhooks for event notifications
  • Monitor watched folders
  • Secure access with IP whitelisting

​
API Keys

API keys are required to authenticate all API requests.

​
Getting Started

If no keys are available, create one to begin:
  • Add Sandbox Key – Use for testing and development
  • Add Production Key – Use for live applications

​
Key Types

  • Sandbox Keys
    • Safe for testing
    • No impact on production data
  • Production Keys
    • Used in live environments
    • Should be securely stored

​
Resources

Quick Start Guide

Start using the API quickly with step-by-step instructions.

API Documentation

Explore endpoints, request formats, and responses.

API Logs

Monitor and debug API activity.

​
Best Practices

  • Never expose API keys in public repositories
  • Rotate keys periodically
  • Use sandbox keys during development

​
Webhooks

Webhooks allow your application to receive real-time event notifications.

​
Adding a Webhook

To create a webhook, provide:
  • Name – Identifier for the webhook
  • Events – Select event type (e.g., outbound fax events)
  • Webhook URL – Destination endpoint that will receive POST requests

​
Optional Security

  • Enable URL Authentication to protect your endpoint
  • Add a username and password for secured delivery

​
Notes

  • Ensure your endpoint is publicly accessible
  • You can test the webhook before saving
  • Handle POST requests and return a 200 OK response

​
Watched Folders

Watched folders allow automated monitoring of specific directories for processing files.

​
Use Cases

  • Automatically detect and process incoming files
  • Trigger workflows when files are added
  • Integrate file-based systems with the API

​
Notes

  • Ensure proper folder permissions are set
  • Monitor activity to avoid duplicate processing

​
Security

The Security tab allows you to restrict API access using IP whitelisting.

​
IP Whitelisting

  • Add trusted IP addresses to limit access

​
Managing IPs

  • Click Whitelist IP Address
  • Add and manage allowed IPs
  • Remove IPs when no longer needed

​
Best Practices

  • Restrict access to known server IPs only
  • Regularly review and update the list
  • Combine with secure API key handling for maximum protection

​
Summary

The Developer Tools section helps you:
  • Securely authenticate API requests
  • Receive real-time updates via webhooks
  • Automate workflows with watched folders
  • Protect access using IP restrictions
Use these tools together to build a secure and reliable integration.