Onboarding Details

Onboarding details overview

Customer onboarding information required for Cisco team configuration and activation.

  • Provide all required onboarding information. After submission, the Cisco internal team validates the details, enters the information into the application, performs the required configuration, and completes onboarding and activation.

To onboard a partner app, provide the following details in this document. The Cisco internal team will create/configure the application and complete onboarding.

App center information

Provide the requested information, images, and selections. The Cisco internal team will enter the information into the application.

  • App Name

  • App Tagline

  • App Icon

  • App Description

  • Primary Industry

  • Company Logo

  • Company Name

  • Company Website

Use cases

(Optional - Only if Use Cases are enabled) Provide a brief description of the intended integration use case and expected business outcome.

  • Use Case Headline: Add the Use Case Headline title.

  • Use Case Icon: Attack the Use Case Icon image.

  • Use Case Short decription: Add the Use Case Short Description.

  • Use Case Long description: Add the Use Case Long Description.

  • Compatibility Notes: Add the Compatibility Notes.

  • Use Case Category: Select the Use Case Category from the dropdown.

  • Use Case Sub-Category: Select the Use Case Sub-Category from the dropdown.

App tile

To ensure consistent application display settings, always provide these fields when configuring an app tile:

  • App Tile Label: Enter the App Tile Label.

  • App Tile Tagline: Enter the App Tile Tagline.

Event types

We recommend these when monitoring updates and changes using event types:

  • Track profile updates, location changes, app activation, and device associations to achieve comprehensive oversight of user and device management.

  • Review event logs for updates related to account administration, device counts, camera counts, network telemetry, Webex telemetry, and presence states to maintain accurate system records.

  • Monitor space occupancy changes and device location updates to support efficient resource allocation and security.

Common event types include:

  • Profile Update.

  • Device Location Update.

  • Device Presence.

  • User Presence.

  • Network Telemetry.

Integration types

Provide the pull channels that best fit your application’s requirements.

  • HTTP,

  • gRPC, and

  • Websocket

Location details for activation

Provide the following location details required for onboarding and activation.

  • To proceed with the activation, provide the exact location hierarchy details:

    Campus or site name.

    Building name or number.

    Floor number.

  • The Cisco internal team will coordinate API key generation and activation activities as part of the onboarding process, if applicable.

  • Confirm your endpoint domain.

    Endpoint domain example:

    Endpoint Domain: https://partners.spaces-gov.cisco/

  • Use the curl command below to preview incoming events, replacing <ENDPOINT_DOMAIN> and <API_KEY> with your values:

    Sample curl command:

    curl "https://<ENDPOINT_DOMAIN>/api/partners/v1/firehose/events" -H "X-API-Key: <API_KEY>"