Integration ID

An Integration ID is a reference you can store on a Shoreline record to match it to the same record in an external system, such as an ERP or CMMS. It gives each object a stable identifier that your integrations can rely on when syncing data between systems.

Where the Integration ID appears

When a record has an Integration ID, it is shown in the object's modal, labelled Integration ID:

Integration IDs are supported on these object types:

Activities
Adverse events
Inventory and inventory groups
Personnel
Work orders and work order tasks
Teams

Set an Integration ID

You can populate Integration IDs in three ways:

CSV import : include the Integration ID column in your import file. The value is written to the matching record.
CSV export : the Integration ID is included in exports, so you can reconcile Shoreline records against your external system.
Public API : assign Integration IDs programmatically (see below).

Assign Integration IDs through the Public API

The Public API can set an Integration ID on a supported object. Each assignment identifies the target object either by its Shoreline ID or by its external ID, and specifies the object type.

A single assignment provides:

Field	Description
`integrationId`	The reference value to store on the record.
`objectType`	One of: `ACTIVITIES`, `ADVERSE_EVENTS`, `INVENTORY`, `INVENTORY_GROUP`, `PERSONNEL`, `WORK_ORDERS`, `WORK_ORDER_TASKS`, `TEAMS`.
`mongoId` or `externalId`	The target record, identified by its Shoreline ID (`mongoId`) or its existing external ID.
`projectId`	The project the record belongs to.

Tip: For full request and authentication details, see the Public API reference.