Using ExternalLink (Incomplete)
This guide details how to use Halo's ExternalLink functionality in order to send/fetch data from Halo's API, used for third party entity matching.
What is ExternalLink
ExternalLink is a table in the Halo database which is used to manage many of the mappings between entities in Halo and respective entities in third-party systems.
Each externalLink record contains a few key values, such as:
- table_id: This value is used to define the entity which is being mapped. See appendix (a) for table_id values and their corresponding context
- module_id: This value is used to identify the 'integration' in question. Value matching is done per module_id so it is important that you send this with every request and that the value you use for module_id remains the same
- third_party_id: This will represent the ID of the entity in your system
Where can ExternalLink be used?
ExternalLink can be used against against any of the entities outlined in Appendix (a)
Using ExternalLink
There are two scenarios where ExternalLink is useful: When creating new records & when updating existing records.
Creating new records
Appendix (a)
Below lists table_id values and the entities they refer to:
| Context | table_id |
|---|---|
| NavigationMenu | -1 |
| System | 0 |
| Faults (Tickets) | 1 |
| Area (Clients) | 2 |
| Site | 3 |
| User | 4 |
| Asset | 5 |
| Contract | 6 |
| Action | 7 |
| Item | 8 |
| Supplier | 9 |
| LiveChatHeader | 980 |
| Team | 986 |
| PurchaseOrderLines | 987 |
| QuotationLines | 988 |
| Invoice | 989 |
| SalesOrder | 990 |
| FAQList | 991 |
| KB | 992 |
| CRMNotes | 993 |
| Attachment | 995 |
| Quotation | 996 |
| AssetGroup | 997 |
| PurchaseOrder | 998 |
| Service | 999 |
| SupplierContract | 1001 |
| Agent | 1002 |
| Organization | 1003 |
| DistributionLists | 1005 |
| DistributionListsLog | 1006 |
| ECommerceOrder | 1007 |
| MailCampaignLog | 1008 |
| MailCampaign | 1009 |
| OutboundIntegrationMethod | 1010 |
| MailCampaignEmail | 1011 |
| Document | 1012 |
| DeviceChange | 1013 |
| EventManagement | 1014 |
| ServiceAvailability | 1015 |
| Downtime | 1016 |
| Appointment | 1017 |
| Lookup | 1018 |
| IntegrationRequest | 1019 |
| DeviceChangeBackup | 1020 |
| ToDoGroups | 1021 |
| ForecastDetails | 1022 |
| SavedForecast | 1023 |