create-hec-event-integration

Name: create-hec-event-integration
Availability: InStock
Author: Bitwarden

Adds a token-authenticated HEC event integration to the Bitwarden web client behind a feature flag.

13.7k|2.0k|Updated Mar 9, 2016

Search Tags:#Jest #bitwarden #typeScript #splunk #feature flag #hec #siem integration

Ready to run

npx skills add https://github.com/bitwarden/clients --skill create-hec-event-integration

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: create-hec-event-integration
Source: https://github.com/bitwarden/clients/tree/main/.claude/skills/create-hec-event-integration
Command: npx skills add https://github.com/bitwarden/clients --skill create-hec-event-integration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Adding a new HEC (HTTP Event Collector) event integration to the Bitwarden web client requires coordinated edits across service name constants, feature flags, card registration, and unit tests, where small mismatches silently break the integration.

Core Features & Use Cases

Guided Prompts: Collects the service name, authentication type, and logo assets before making any code changes.
Coordinated Code Changes: Adds the service name constant, feature flag with default, and integration card registration in the correct files.
Test Coverage: Generates typed unit tests for buildHecConfiguration and buildHecTemplate and runs them with Jest.
Use Case: A developer needs to add a new SIEM service like Blumira as an event integration; the skill walks through each file edit and verifies all tests pass.

Quick Start

Ask the assistant to add a new HEC event integration for your service name to the Bitwarden web client.

Frequently Asked Questions about create-hec-event-integration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I add a new HEC event integration to the Bitwarden web client?▼

Add the service name to OrganizationIntegrationServiceName, create a feature flag with a FALSE default, register the integration card in organization-integrations.resolver.ts behind that flag, and add unit tests for buildHecConfiguration and buildHecTemplate.

What authentication methods does the HEC integration support?▼

The skill supports token-based authentication only, using the Splunk model of a Bearer token plus URI. API key integrations or custom connect dialogs are not covered and require a different approach.

Why does my HEC integration save with the wrong service name?▼

The card's name field must exactly match the string value in OrganizationIntegrationServiceName, because saveHec casts the card name directly. Any mismatch silently saves the configuration with the wrong service name.

Do I need a new OrganizationIntegrationType for each HEC service?▼

No. All HEC services share OrganizationIntegrationType.Hec, and the existing HecConfiguration and HecTemplate classes handle every service. New HEC services fall into the existing openHecConnectDialog flow automatically.

What happens if integration logos are not ready yet?▼

Use placeholder image paths in the card registration and add a TODO comment to add the logo before shipping. When ready, copy SVGs to apps/web/src/images/integrations/ following the logo-<service>-color.svg naming convention.