Cisco Webex Setup

Cisco Webex Setup

Prerequisites

Workflow Overview

┌───────────┐   ┌────────────────┐   ┌──────────────────┐   ┌────────────────────┐
│ Preflight │ → │ Install add-on │ → │ Configure inputs │ → │ Validate dashboards │
└───────────┘   └────────────────┘   └──────────────────┘   └────────────────────┘

When to Activate

• Onboard Webex Meetings, administrative audit, quality, or calling data.
• Configure generic Webex REST or Contact Center search inputs.
• Diagnose OAuth, index, source-type, macro, or dashboard failures.

Scope

This skill configures documented Webex collection and dashboard prerequisites. It does not create OAuth applications, expose tokens in chat, or enable every endpoint without reviewing scope, privacy, rate limits, and event volume.

Examples

Install the Webex add-on and companion app:

bash skills/cisco-webex-setup/scripts/setup.sh --install

Expected output: required packages and index/macro prerequisites are installed or a topology-specific manual handoff is emitted.

Run strict completion checks after configuring selected inputs:

bash skills/cisco-webex-setup/scripts/validate.sh --completion

Expected output: package, OAuth account, enabled input, event, macro, and dashboard evidence report [PASS]; incomplete coverage exits nonzero.

Troubleshooting

TA Completion Gate

For every TA/add-on or dashboard companion run, satisfy the shared TA completion gate: configure and enable the data ingest path owned by this skill or its required companion, validate events or metrics in the target indexes/source types, and verify any pre-built/package-shipped dashboards are visible, macro-aligned, and returning data. If the package ships no dashboards, record that evidence explicitly and hand off dashboard use to the consuming app, ES/ITSI/ARI content, or readiness doctor.

Automates the Webex Add-on for Splunk (ta_cisco_webex_add_on_for_splunk, Splunkbase 8365) and the companion Webex App dashboards (cisco_webex_meetings_app_for_splunk, Splunkbase 4992).

Package Model

Install public Splunkbase packages through splunk-app-install first. The normal workflow installs both the add-on and app, then this skill creates the dashboard indexes/macros and configures Webex REST accounts/inputs over Splunk REST.

Package-derived defaults:

Credentials

Never ask for Webex client secrets, access tokens, or refresh tokens in chat. Proxy passwords must use the same local secret-file pattern. Use local secret files:

bash skills/shared/scripts/write_secret_file.sh /tmp/webex_client_secret

Splunk credentials are read from the project-root credentials file or ~/.splunk/credentials.

Workflow

1. Install packages and configure indexes/macros:

bash skills/cisco-webex-setup/scripts/setup.sh --install

2. Configure the Webex OAuth account:

bash skills/cisco-webex-setup/scripts/configure_account.sh \
  --name WEBEX_PROD \
  --client-id "client-id" \
  --client-secret-file /tmp/webex_client_secret \
  --scope "meeting:admin_schedule_read spark-admin:people_read" \
  --redirect-url "https://example.splunkcloud.com/en-US/app/ta_cisco_webex_add_on_for_splunk/oauth_redirect"

3. Create inputs as needed:

bash skills/cisco-webex-setup/scripts/configure_inputs.sh \
  --account WEBEX_PROD \
  --input-type core \
  --start-time "2026-05-01T00:00:00Z" \
  --site-url "https://yoursite.webex.com"

--site-url is required for the core batch because it includes the meetings_summary_report input. Omitting it makes the core run fail when it reaches that input.

4. Validate:

bash skills/cisco-webex-setup/scripts/validate.sh --completion

Input Coverage

Use configure_inputs.sh --input-type with one of:

• core: scheduled meetings, admin audit, security audit, meeting qualities, meeting summary reports, detailed call history.
• meetings, meetings_summary_report, admin_audit_events, security_audit_events, meeting_qualities, detailed_call_history.
• generic_endpoint: requires --webex-endpoint; do not include a leading /. Use --webex-base-url when the endpoint needs a host other than webexapis.com.
• contact_center_search: requires --org-id and --webex-contact-center-region; templates are AAR, ASR, CAR, CSR.

Detailed call history accepts --account-region and --locations, but the packaged REST handler has a narrow locations validator. Prefer omitting --locations unless the installed package has been verified for the intended value format.

See reference.md for the package-derived sourcetypes, scopes, and timing guardrails.

Validation Modes

Run scripts/validate.sh for diagnostics. Use --completion (alias --strict) to require the Webex add-on and dashboard app, dashboard macros/views, an OAuth account, an enabled input, and event data in the Webex indexes.