This skill should be used when the user asks to "create an event collector", "build an event collector", "write an event collector", "ingest events into XSIAM", "fetch events", "send_events_to_xsiam", "isfetchevents", "XSIAM event ingestion", or needs to build a specialized integration that ingests vendor events into the XSIAM data lake. For standard API integrations that create incidents, use the xsiam-integrations skill instead. For standalone data-processing scripts, use xsiam-scripts.
التثبيت
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
This skill should be used when the user asks to "create an event collector", "build an event collector", "write an event collector", "ingest events into XSIAM", "fetch events", "send_events_to_xsiam", "isfetchevents", "XSIAM event ingestion", or needs to build a specialized integration that ingests vendor events into the XSIAM data lake. For standard API integrations that create incidents, use the xsiam-integrations skill instead. For standalone data-processing scripts, use xsiam-scripts.
XSIAM Event Collector Development
Generate importable unified YAML files for Cortex XSIAM event collector integrations. Event collectors ingest vendor events directly into the XSIAM data lake via send_events_to_xsiam(). Unlike regular fetch-incidents integrations (which create incidents in the queue), event collector data lands in the data lake and is queryable via XQL. The Python code MUST be embedded directly inside the YAML file — this is the only format XSIAM accepts for import.
../xsiam-integrations/references/integration-patterns.md — BaseClient, auth (OAuth/basic/token caching), pagination, rate limiting, proxy/SSL. Load this when the vendor API needs a non-trivial auth flow or pagination pattern; the complete example in event-collector-spec.md already covers the simple bearer-token + single-page case.
What is an Event Collector?
Event collectors are specialized integrations that ingest vendor events into the XSIAM data lake. They authenticate to a vendor's events/logs API, fetch events on a schedule, and push them to XSIAM via send_events_to_xsiam().
When to use which skill:
Events -> data lake -> XQL queryable -> event collector (this skill)
vendor and product strings for XSIAM (lowercase, used in dataset naming: vendor_product_raw)
Timestamp field name in source events (must be mapped to _time)
Whether multiple event types need separate streams (separate send_events_to_xsiam() calls per vendor/product pair)
Authentication method — match the API's auth scheme to the correct pattern:
Auth scheme
Pattern
API key in header
Bearer token via _get_headers()
API key (type 4 encrypted)
params.get('api_key') directly
Credentials (type 9 auth)
params.get('credentials', {}).get('password', '')
Username + password
HTTPBasicAuth via _http_request(auth=)
OAuth2 client credentials
Token caching with getIntegrationContext() + expiry
Certificate-based
Mutual TLS via _http_request() cert params
2. Generate the Unified YAML
Build a single .yml file following these ordered sub-steps. The YAML structure must match real XSIAM export format for successful import.
Top-level metadata — commonfields (id, version: -1), then vcShouldKeepItemLegacyProdMachine: false, then name, display, category, description. The identity must mark this as an event collector: real exports set id, name, and display to the same string ending in Event Collector (spaces allowed, e.g. Abnormal Security Event Collector). A spaceless EventCollector form is also valid and is the convention for the file name and the register_module_line/class identifier.
configuration — Each parameter starts with supportedModules: [], then section:, then remaining fields. Auth params in Connect section; first_fetch, max_events in Collect section; insecure/proxy in Connect with advanced: true. Always include additionalinfo tooltips.
Command definitions — implement test-module, fetch-events, and
<prefix>-get-events (with should_push_events, limit, and start_time arguments).
Only <prefix>-get-events is listed in the commands array; test-module and
fetch-events are implicit platform commands. Each listed command and argument starts
with supportedModules: []. See ### Required Commands in
references/event-collector-spec.md for the listing rule and should_push_events behavior.
Embed Python code — insert into script.script: |- with register_module_line() calls as the first and last lines
Configuration Parameter Field Order
Each configuration parameter follows the field order documented under
### Configuration Parameters in references/event-collector-spec.md (matching real
XSIAM exports).
Command and Argument Field Order
Command and argument field order is documented under ### Required Commands in
references/event-collector-spec.md.
3. Python Code Conventions
Same BaseClient pattern as integrations, with these event-collector-specific differences:
register_module_line() — include as first and last lines of the embedded Python code, matching the integration name (e.g., register_module_line('VendorNameEventCollector', 'start', __line__()))
Global constants — define VENDOR and PRODUCT as module-level constants, reference them in send_events_to_xsiam() calls
fetch-events command calls send_events_to_xsiam(events, vendor, product) — never demisto.incidents()
<prefix>-get-events is a debug command: accepts should_push_events argument. When false, returns CommandResults with events as readable output only. When true, also calls send_events_to_xsiam().
Every event must have a _time field in ISO 8601 format — map from the source timestamp field during fetch
demisto.getLastRun() / demisto.setLastRun() tracks last event timestamp per event type
For multiple event types, call send_events_to_xsiam() separately for each vendor/product pair
Do not includefrom CommonServerPython import *, from CommonServerUserPython import *, or import demistomock as demisto — the platform injects these automatically at runtime. Unified YAML must not contain them. Third-party imports like import dateparser are fine.
4. File Output
Generate a single file:
VendorEventCollector.yml — the unified YAML ready for import into XSIAM
Optionally also generate:
VendorEventCollector_test.py — pytest test file (separate, not for import)
Before delivering, run the embedded-Python parse check and confirm it exits 0 (prints OK). If it errors, fix the YAML/Python before delivering:
python3 -c "import yaml, ast; d = yaml.safe_load(open('VendorEventCollector.yml')); ast.parse(d['script']['script']); print('OK')"
This catches misindented block scalars, tab characters, and Python syntax errors that the eyeball checks below can miss.
Requires PyYAML (pip install pyyaml); if it isn't installed, skip this check and rely on the checklist below.
6. Validation Checklist
Before delivering, verify:
commonfields.id, name, and display are consistent and end with Event Collector (spaced, e.g. Abnormal Security Event Collector) or the spaceless EventCollector form
vcShouldKeepItemLegacyProdMachine: false present after commonfields
sectionorder uses lowercase 'o' (not camelCase)
script.isfetchevents is true; script.isfetch is false
Every configuration parameter has supportedModules: [] as its first field
Every command definition has supportedModules: [] as its first field
Every argument definition has supportedModules: [] as its first field
Config params have section: field assigning them to Connect or Collect
Config params have additionalinfo: tooltips
insecure and proxy params have advanced: true
Only <prefix>-get-events is listed in commands array — test-module and fetch-events are NOT listed (they are implicit platform commands)
<prefix>-get-events has should_push_events argument with predefined values
fetch-events calls send_events_to_xsiam(events, vendor, product) — not demisto.incidents()
<prefix>-get-events respects should_push_events flag
VENDOR and PRODUCT defined as module-level constants
vendor and product strings are lowercase
Every event has a _time field in ISO 8601 format
demisto.setLastRun() tracks last event timestamp
Boundary dedup: IDs of events at the latest _time are stored in LastRun (last_ids) and filtered out on the next fetch — since= is inclusive, so without this the boundary events are ingested twice
register_module_line() present as first and last lines of Python code
Python code is embedded in script.script: |- (nested, not top-level)
Python indentation is consistent within the YAML block
NoCommonServerPython, CommonServerUserPython, or demistomock imports — the platform injects these at runtime
main() has try/except with return_error()
BaseClient subclass used for all HTTP calls via _http_request()
test-module command is implemented and routes correctly in main()
script.type is python (not python3); script.subtype is python3
Docker image is a pinned 3.12.x version (not :latest)
Do not includefromversion, marketplaces, tests — content-pack CI fields only. Also omit timeout: it is a valid field only in script YAML, not in integration/event-collector YAML.
No tab characters; consistent YAML indentation throughout
Key Conventions
Integration name: id/name/display end with Event Collector (spaced form, e.g. Vendor Name Event Collector, matching real exports); the spaceless VendorNameEventCollector form is used for the file name and the class/register_module_line identifier
Command prefix: lowercase vendor name (e.g., vendorname-get-events)
