# Create a case Source: https://docs.arb.inc/api-reference/cases/create-a-case /api-reference/api.yaml post /cases/create Creates a new arbitration case for the authenticated user's organization. All fields are optional — calling with an empty body creates a case with default settings (14-day response period, default ruleset). # List active cases for the signed-in user Source: https://docs.arb.inc/api-reference/cases/list-active-cases-for-the-signed-in-user /api-reference/api.yaml post /cases/list Returns the user's active cases with simple pagination via a cursor. # View a case Source: https://docs.arb.inc/api-reference/cases/view-a-case /api-reference/api.yaml post /cases/view Returns a simple snapshot of a case the user can access. # Get a signed PDF URL for a docket entry Source: https://docs.arb.inc/api-reference/docket/get-a-signed-pdf-url-for-a-docket-entry /api-reference/api.yaml post /docket/entries/pdf Returns a time-limited, signed URL to download the PDF for a specific docket entry within a case. # List docket entries for a case Source: https://docs.arb.inc/api-reference/docket/list-docket-entries-for-a-case /api-reference/api.yaml post /docket/entries/list Gets a list of entries in a cases docket. # Delete an uploaded evidence file Source: https://docs.arb.inc/api-reference/evidence/delete-an-uploaded-evidence-file /api-reference/api.yaml post /evidence/uploads/delete Removes a specific upload from a case if you have access. # Get a download link for an uploaded file Source: https://docs.arb.inc/api-reference/evidence/get-a-download-link-for-an-uploaded-file /api-reference/api.yaml post /evidence/uploads/download Returns a short-lived URL so you can download the upload. # List evidence uploads for a case Source: https://docs.arb.inc/api-reference/evidence/list-evidence-uploads-for-a-case /api-reference/api.yaml post /evidence/uploads/list Returns the uploads the user is allowed to access for a given case. # Upload evidence to a case Source: https://docs.arb.inc/api-reference/evidence/upload-evidence-to-a-case /api-reference/api.yaml post /evidence/uploads/create Upload one file to a case with a short description. # Create a document Source: https://docs.arb.inc/api-reference/filings/create-a-document /api-reference/api.yaml post /filings/documents/create Creates a new document for a case using a document template. # Delete a filed document Source: https://docs.arb.inc/api-reference/filings/delete-a-filed-document /api-reference/api.yaml post /filings/documents/delete Removes a document from a case if it’s still eligible for deletion. # Get a temporary PDF URL for a filed document Source: https://docs.arb.inc/api-reference/filings/get-a-temporary-pdf-url-for-a-filed-document /api-reference/api.yaml post /filings/documents/pdf Returns a short-lived URL to download the PDF of a filed document in a case. # List filed documents for a case Source: https://docs.arb.inc/api-reference/filings/list-filed-documents-for-a-case /api-reference/api.yaml post /filings/documents/list Returns filed documents for a specific case that the signed-in user participates in. # Submit a filed document Source: https://docs.arb.inc/api-reference/filings/submit-a-filed-document /api-reference/api.yaml post /filings/documents/submit Sends a filed document for approval in a case. # Update a filed document Source: https://docs.arb.inc/api-reference/filings/update-a-filed-document /api-reference/api.yaml post /filings/documents/update Updates a document in a case with new field values. # View a filed document Source: https://docs.arb.inc/api-reference/filings/view-a-filed-document /api-reference/api.yaml post /filings/documents/view Returns the details of a filed document for a given case and filing. # Withdraw a filed document Source: https://docs.arb.inc/api-reference/filings/withdraw-a-filed-document /api-reference/api.yaml post /filings/documents/withdraw Removes a filed document from a case if it hasn’t been docketed. # List users in your organization Source: https://docs.arb.inc/api-reference/organization/list-users-in-your-organization /api-reference/api.yaml post /organization/users/list Gets a simple list of users who are in the same organization. # Add a participant to a case Source: https://docs.arb.inc/api-reference/participants/add-a-participant-to-a-case /api-reference/api.yaml post /participants/add Adds a user to a case. You must be logged into an organization, and the user you add must be in the same organization. # List schemas Source: https://docs.arb.inc/api-reference/schemas/list-schemas /api-reference/api.yaml post /schemas/list Retrieves all available schemas for case phases and documents. # Create a service-of-notice mailing Source: https://docs.arb.inc/api-reference/service-of-notice/create-a-service-of-notice-mailing /api-reference/api.yaml post /service-of-notice/mailings/create Create a service-of-notice mailing. Send JSON data in the `data.content` field for dynamic mail templates. # Generate a service-of-notice attachment Source: https://docs.arb.inc/api-reference/service-of-notice/generate-a-service-of-notice-attachment /api-reference/api.yaml post /service-of-notice/attachments/create Takes a screenshot of the provided URL and returns it as a PNG image sized for the specified mail type. Use this to programmatically generate the optional image that appears on a service-of-notice mailing. # Home Source: https://docs.arb.inc/index Modern arbitration platform for efficient dispute resolution ## The Digital Arbitration Platform Arb, Inc. provides a comprehensive platform for managing arbitration cases from filing through final award. Built for claimants, respondents, and arbitrators to collaborate efficiently in resolving disputes. ## Key Features > [card] Case Management > > Comprehensive case tracking with phase transitions and procedural timetables > [card] Digital Docket > > Complete record of all case activities, filings, and communications > [card] Document Filing > > Submit claims, responses, evidence, and motions digitally > [card] Party Management > > Manage claimants, respondents, and representatives > [card] Deadline Tracking > > Automated reminders and procedural timeline management > [card] Secure Access > > Role-based permissions with secure authentication # Node.js SDK Source: https://docs.arb.inc/sdks/node Official TypeScript/JavaScript SDK for Arb Platform API ## Installation Install the Arb SDK using npm or your preferred package manager: ```bash npm theme={null} npm install @arb-inc/node ``` ```bash yarn theme={null} yarn add @arb-inc/node ``` ```bash pnpm theme={null} pnpm add @arb-inc/node ``` ## Quick Start Set up your API key as an environment variable: ```bash theme={null} export ARB_INC_API_KEY="your_api_key_here" ``` Create a file called `example.js` and add this code: ```javascript theme={null} import ArbInc from '@arb-inc/node'; const client = new ArbInc({ apiKey: process.env['ARB_INC_API_KEY'], // This is the default and can be omitted }); const _case = await client.cases.create({ primaryUserID: 'c17c3433-81b3-4096-90e0-9fbb32c06204' }); console.log(_case.caseID); ``` Execute the code with `node example.js`. You should see the case ID output. ## TypeScript Support The SDK includes full TypeScript definitions for all request params and response fields: ```typescript theme={null} import ArbInc from '@arb-inc/node'; const params: ArbInc.CaseCreateParams = { primaryUserID: 'c17c3433-81b3-4096-90e0-9fbb32c06204' }; const _case: ArbInc.CaseCreateResponse = await client.cases.create(params); ``` > [card] [Learn more on GitHub](https://github.com/arb-inc/arb-node) > > Discover more SDK capabilities, configuration options, and complete API documentation on the library's GitHub README. > [card] [View on npm](https://www.npmjs.com/package/@arb-inc/node) > > See package details, version history, and installation statistics. ## Requirements * Node.js 20 LTS or later * TypeScript >= 4.9 (for TypeScript users) ## Support For SDK issues or questions: * [Open an issue on GitHub](https://github.com/arb-inc/arb-node/issues) * Email support at [support@arb.inc](mailto:support@arb.inc) # SDKs & Libraries Source: https://docs.arb.inc/sdks/overview Official SDKs and libraries for integrating with Arb Platform API ## Available SDKs Arb provides official SDK libraries to make it easy to integrate our API into your applications. Our SDKs handle authentication, request formatting, and provide type-safe interfaces for all API operations. > [card] [Node.js SDK](/sdks/node) > > TypeScript/JavaScript SDK for Node.js applications > [card] More SDKs Coming Soon > > Python, Go, and Ruby SDKs are in development ## Features All our SDKs provide: * **Type Safety**: Full TypeScript support with comprehensive type definitions * **Authentication**: Built-in authentication handling with API keys * **Error Handling**: Consistent error handling and retry logic * **Documentation**: Inline documentation and code examples * **Testing**: Comprehensive test coverage ## Quick Start Choose your preferred language SDK from the options above to get started with installation and usage instructions. ## Support For SDK-specific issues or feature requests, please visit the respective GitHub repository or contact our support team. # Case Closed Source: https://docs.arb.inc/webhooks/case-closed Fired when a case is closed. This event fires when a case reaches its conclusion and is officially closed. This typically happens after the arbitrator issues the final award during the Award Issuance phase. ## Payload **caseID** `string` *required* The case that was closed. ## Example ```json theme={null} { "id": "a3b4c5d6e7f8", "timestamp": "2025-09-20T09:15:00Z", "event": "case_closed", "data": { "caseID": "2025-08-00292" } } ``` ## What to do next Once a case is closed, you may want to: * Archive the case in your internal system * Retrieve the final award from the [docket](/api-reference/docket/list-docket-entries-for-a-case) and download the [PDF](/api-reference/docket/get-a-signed-pdf-url-for-a-docket-entry) * Update your records with the outcome * Notify relevant stakeholders # Docket Filing Source: https://docs.arb.inc/webhooks/docket-filing Fired when a document is added to the case docket. This event fires every time a document is officially added to a case's docket — whether filed by the claimant, respondent, or case manager. Use it to trigger workflows like logging filings, notifying your team, or automatically preparing a response. ## Payload **entryID** `string` *required* Unique identifier for this docket entry. **enteredAt** `string` *required* ISO 8601 timestamp of when the entry was added to the docket. **filingID** `string` *required* Unique identifier for the document filing. **caseID** `string` *required* The case this filing belongs to. **phaseID** `string` *required* The phase the case was in when the document was filed. See [Schemas](/api-reference/schemas/list-schemas) for valid phase IDs. **documentID** `string` *required* The type of document that was filed (e.g. `statementOfClaim`, `statementOfResponse`, `motion`). See [Schemas](/api-reference/schemas/list-schemas) for all document types. **userID** `string` *required* The user who filed the document. **organizationID** `string` The organization of the user who filed, if applicable. **partyID** `string` *required* The party role of the filer (e.g. `claimant`, `respondent`, `caseManager`). **rootEntryID** `string` If this entry is related to another docket entry, the ID of the root entry in the chain. **parentEntryID** `string` If this entry is a direct reply to another docket entry, the ID of the parent entry. ## Example ```json theme={null} { "id": "9e9d96c0d6dd", "timestamp": "2025-08-15T14:32:10Z", "event": "docket_filing", "data": { "entryID": "14", "enteredAt": "2025-08-15T14:32:09Z", "filingID": "12", "caseID": "2025-08-00292", "phaseID": "response", "documentID": "statementOfResponse", "userID": "fa386739-9ff0-4c05-a355-7a21679f2bee", "organizationID": "04d9e4f5-4b00-41b1-9164-60c880ffb64e", "partyID": "respondent", "rootEntryID": null, "parentEntryID": null } } ``` # Overview Source: https://docs.arb.inc/webhooks/overview Receive real-time notifications when events happen in your cases. Webhooks let your system react to events as they happen, like a document being filed, a case moving to a new phase, or a case being closed. Instead of polling the API, you register a URL and we send you a POST request whenever something important occurs. ## How it works 1. **Register a URL** in your organization's [developer settings](https://app.arb.inc/settings/developers). 2. **Events fire** as your cases progress through the arbitration process. 3. **We send a POST request** to your URL with a JSON payload describing what happened. Every webhook is delivered via a POST request with a JSON body and the header `x-service: webhooks.platform.arb.inc`. ## Envelope format Every webhook event is wrapped in the same envelope structure: **id** `string` *required* Unique identifier for this event. Deterministic — retries of the same event produce the same ID, so you can use it for deduplication. **timestamp** `string` *required* ISO 8601 timestamp of when the event occurred. **event** `string` *required* The event type. One of `docket_filing`, `phase_changed`, or `case_closed`. **data** `object` *required* Event-specific payload. Structure depends on the `event` type. ```json Example Envelope theme={null} { "id": "9e9d96c0d6dd", "timestamp": "2025-08-15T14:32:10Z", "event": "docket_filing", "data": { ... } } ``` ## Event types | Event | Fired when | | - | - | | [`docket_filing`](/webhooks/docket-filing) | A document is added to the case docket | | [`phase_changed`](/webhooks/phase-changed) | A case transitions to a new phase | | [`case_closed`](/webhooks/case-closed) | A case is closed | ## Retry behavior Webhooks are delivered through a managed task queue with automatic retries. If your endpoint returns a non-2xx status code or times out (60-second limit), delivery will be retried. The `id` field is deterministic — the same event always produces the same ID, even across retries. Use it to safely deduplicate incoming webhooks on your end. ## Best practices > [accordion] Respond quickly > > Return a 2xx status code as fast as possible. Do heavy processing asynchronously after acknowledging receipt. > [accordion] Deduplicate by ID > > Store the `id` of each processed webhook. If you receive the same ID again, skip processing — it is a retry. > [accordion] Verify the source > > Webhooks include the header `x-service: webhooks.platform.arb.inc`. While not a cryptographic signature, you can use it as a basic check along with keeping your webhook URL secret. > [accordion] Handle events out of order > > Webhooks may arrive out of order. Use the `timestamp` field and your own case state to handle this gracefully. # Phase Changed Source: https://docs.arb.inc/webhooks/phase-changed Fired when a case transitions to a new phase. This event fires when a case moves from one phase to the next in the arbitration process. Use it to trigger time-sensitive actions — like filing documents that are only allowed in certain phases, or notifying your team that a deadline window has opened. ## Phases Cases progress through these phases in order: | Phase ID | Name | What happens | | - | - | - | | `caseInitiation` | Case Initiation | Claimant creates the case and files their statement of claim. | | `caseFiling` | Case Filing | Claimant pays the filing fee and initiates service of notice to the respondent. | | `response` | Response | Respondent is given a window to join the case and submit their statement of response. | | `arbitratorAppointment` | Arbitrator Appointment | A neutral arbitrator is assigned to the case. | | `caseManagementConference` | Case Management Conference | Parties may file motions. The arbitrator outlines upcoming deadlines. | | `evidenceSubmissions` | Evidence Submissions | Both parties submit any remaining evidence. | | `evidenceExchange` | Evidence Exchange | All private evidence becomes visible to both sides. | | `preHearingSubmissions` | Pre-Hearing Submissions | Both parties submit their final written statements. | | `hearing` | Hearing | The case manager organizes all materials for the arbitrator. | | `deliberation` | Deliberation | The arbitrator reviews everything and prepares a decision. | | `awardIssuance` | Award Issuance | The arbitrator issues the final award and the case is closed. | ## Payload **caseID** `string` *required* The case that changed phases. **previousPhaseID** `string` *required* The phase the case transitioned from. **currentPhaseID** `string` *required* The phase the case transitioned to. ## Example ```json theme={null} { "id": "5196af625fdd", "timestamp": "2025-08-15T14:32:10Z", "event": "phase_changed", "data": { "caseID": "2025-08-00292", "previousPhaseID": "evidenceExchange", "currentPhaseID": "preHearingSubmissions" } } ``` ## Common patterns > [accordion] Auto-file final statement when pre-hearing opens > > Listen for `currentPhaseID: "preHearingSubmissions"` and automatically create and submit your Final Statement of Case using the [filing endpoints](/api-reference/filings/create-a-document). > [accordion] File a motion when respondent doesn't respond > > If the case moves from `response` to `arbitratorAppointment` without the respondent filing, you can file a motion requesting a default ruling.