If you have developed an integration with Adapt that is not embedded in the Adapt UI and you want to control the UI (e.g. to display a record or run workflow) you should use the External Request mechanism. The full documentation for External Requests can be found here.


The External Request mechanism operates via a URL and invokes a page that communicates with Adapt to invoke the requested functionality. The base URL for all External Requests is:



<adapt_server> is the name or IP address of the Adapt server

<adapt_port> defines the port that Adapt is accessed on.

This part of the URL is the same as users normally use when accessing Adapt.

Individual operations are invoked by including additional parameters as part fo the URL that define the action to be carried out and any addtional data that is needed by that action. Invoking the base URL without any parameters will display help text to get you started using the mechanism.



Through the external request URL you can:

  • Open an Entity
  • Start a Workflow
  • Run a business object
  • Import a CV


Open an Entity

Opening an entity will cause the entity to be displayed in the Adapt UI as though the user had opened from a link in the system. Additional parameters can be specified to determine the view used (based on specifying the role type) and which page (segment) of the entity should be displayed.


Start a Workflow

Starting a workflow invokes one of the Adapt workflows that form part of the Adapt application - for example, Log a Phone Call or Add Contact. These are normally invoked from menus or buttons within the Adapt User Interface. They start by raising a view in a dialog, therefore to invoke a workflow through an External Request you will need to know the ID of the view that is the starting point of the workflow. In addition you can specify an entity to be opened prior to running the workflow (useful for workflows which expect to retrieve information from the currently open entity) and data to populate fields on the workflow with.


Run a Business Object

Business Objects can be thought of as being similar to macros and are used to implement all the business logic in an Adapt application. Using an Eternal Request a business object can be run (by specifying its ID) and just as for running workflow, an entity to open first and data to be passed to the BO can also be specified.


Import a CV

Adapt includes a tool for parsing candidate data out of a CV/Resume document and using it to create or update entities. This tool can be invoked by an External Request and used to import one or more CVs from either local storage or from a remote server via an authenticated HTTP request.


© Erecruit Holdings LLC