Skip to main content

API Introduction

Records Rocket provides a modern, RESTful API and webhook system to allow for seamless integration with your existing case management software and other internal tools.

Design Principles​

Our API is built with the following principles in mind:

  • RESTful: We use standard HTTP verbs (GET, POST, PUT, DELETE) and predictable, resource-oriented URLs.
  • JSON-Based: All API requests and responses, including errors, use JSON.
  • Secure: All endpoints require authentication and are subject to the same rigorous, role-based access controls as the web application.
  • Asynchronous-First: For long-running tasks like document processing and report generation, our API uses an asynchronous model. You initiate a task and then poll a status endpoint to check for completion.

Base URL​

All API endpoints are relative to your Records Rocket instance URL. The base path for the API is /api.

https://your-instance.recordsrocket.com/api/

Webhooks​

In addition to the REST API, Records Rocket can be configured to send webhook notifications to your systems when key events occur, such as:

  • A document finishes processing.
  • A report has been generated.
  • A case status is updated.

This allows you to build real-time integrations without the need for constant polling.