Skip to content
  • There are no suggestions because the search field is empty.

Register an incoming application

Generate an application for use with the Casebook API

Introduction

Interactions with the Casebook API require the configuration of one or more incoming applications with defined roles and permissions.

This developer guide walks through the creation of an incoming application for use with the Casebook API.

Prerequisites

Your organization must be licensed for External Data Interoperability (API) to interact with the Casebook API.

Instructions

Register incoming applications and assign roles with the right level of access to ensure that each application can perform only the operations you intend.

  1. Navigate to Casebook → Admin → Global → Integrations → Incoming integrations

  2. Click on the Register an external application button in the bottom right corner of the page to add a new application:

    1. Application name (Required): Enter an internal name for the application that you want to register. This name will be displayed on records modified by the application in fields like “Created by” and “Last updated by”.

    2. Email (Required): Enter a unique email address where you would like to receive alerts and notifications about this integration. Because each application is a separate account with assigned roles, this email address cannot be associated with an existing Casebook account, including your own. See Tips below for suggestions.

    3. Roles (Required): Select one or more roles to define the application’s access to the Casebook system. See Tips below for suggestions.

    4. Application URL (Optional): Enter a URL for the application you are registering.

    5. Description (Optional): Describe the purpose of this incoming application.

  3. Click “Save” to create the incoming application.

Tips

For stronger security, create separate applications for different use cases or distinct permission sets rather than granting broad access to a single application

Create a custom role for your integration in Admin → Global → Roles if default roles are not a good fit

To receive alerts and notifications about your integration sent to your email address, consider creating aliases or subaddresses offered by some email providers including Microsoft and Google Workspace which can be used to create unique email addresses that automatically forward messages to your inbox

Next steps

Next, use your application to obtain an access token for use with the Casebook API:

For more help with the Casebook API, get in touch with the Casebook Support team.