create_event_typeCreate a custom event type for use in event-driven strategies.
Area
Discovery & Research
Group
Event management
Access
Write
Risk
May change server state
Details
Full description
Details
Create a custom event type for use in event-driven strategies.
Only call this after list_event_types confirms no existing system or custom type matches. Reusing a system event type is always preferred over a near-duplicate custom one — system types are already backfilled and maintained.
After creating — use ingest_events() to add historical occurrences, then reference the event_type_id in strategy conditions via builder_add_condition(type="event").
Args
event_type_id— unique kebab-case id (e.g.fomc-meeting,my-signal)name— display name (e.g.FOMC Meeting)description— what the event represents
Requires the CUSTOM_EVENTS capability. Fails if the id format is invalid or already exists.
Capabilities
Bounded options and operating modes surfaced above the full JSON schema.
Required Inputs
event_type_idstringUnique kebab-case ID for this event type: lowercase letters and digits separated by single hyphens (e.g. 'my-sentiment-score', 'earnings-surprise-flag'). System event types use dotted '<category>.<name>' ids such as 'macro.cpi', so a custom id cannot collide with one.namestringHuman-readable nameOptional Inputs
descriptionstringWhat this event representspayload_schemaanyOf (2 variants)Optional schema for event payloads: {fields:{<name>:<number|boolean|string>}, required:[...]}.