External Integrations
Core Platformintegrations_readExternal IntegrationsDevice ManagementThe External Integrations a facility uses. partner_configs covers every partner integration (membership and booking systems, payments, the network controller, alarm monitoring, CRM lead forwarding and others): whether it is enabled and its settings, with secrets shown only as set or not. facility_config covers settings kept on the facility itself: alarm relay, directory listings, and chat channels. test_network_controller checks that an on-site device can sign in to the facility's network controller. Pass facilityIds to check several facilities.
Actions:
- partner_configs: Partner integrations. Partners available to the facility, enabled or not.
- facility_config: Facility integration settings.
- test_network_controller: Test the network controller. Asks an online, preferably wired, Performance Hub device at the facility to sign in to the network controller set up in External Integrations. Times out when the controller address is wrong or on another network.
Parameters
| Name | Type | Description |
|---|---|---|
action* | "partner_configs" | "facility_config" | "test_network_controller" | What to do; each action is described in the tool description. |
facilityId | string | Facility ID. Optional when the connected facility is the one you mean. |
facilityIds | array | Several facility IDs, to run the same request at each. Use instead of facilityId. |
partnerId | string | Only this partner ID (partner_configs) |
partnerName | string | Partner name or code contains this (partner_configs) |
enabledOnly | boolean | Only enabled integrations (partner_configs) |
timeoutMs | integer | How long to wait for the device, in milliseconds (default 10000) (test_network_controller) |