Developer Portal

The Developer Portal lets firm admins connect CaseSolo to external systems using API keys, webhooks, and the public OpenAPI documentation.

Who Can Use It

Only admins can view the Developer Portal or create API keys. This protects firm data and prevents accidental third-party access.

Creating An API Key

1. Open Developer Portal.
2. Enter a clear key name, such as Production CRM or Zapier Intake.
3. Select only the permissions the integration needs.
4. Select Create Key.
5. Copy the new key immediately. CaseSolo only shows the full key once.

If a key is no longer needed, delete it from the key list.

Webhooks

Webhooks send real-time CaseSolo events to another system. The portal shows configured endpoints and supported event names. Use Webhook Wizard to add, test, replay, or update endpoints.

OpenAPI Docs

The OpenAPI JSON links describe the public API contract. Developers can use these links to inspect endpoints, generate clients, or build custom integrations.

Troubleshooting

• If an integration stops working, check whether the API key was deleted or expired.
• If a webhook is failing, open the Webhook Wizard and review delivery history.
• If rate-limit remaining is low, reduce polling or switch to webhook-based automation.
• If an external developer asks for documentation, send the public OpenAPI JSON link from the portal.