events

README

Generated events

This package contains code generated via go generate. It contains both JSON and Go types for all events defined within the defs/ top-level directory.

Documentation

Index

• Variables
• type Event

Variables

var Events []Event

Events list a subset of events ingested via integrations into Inngest, with cue and JSON schema fields documenting their format.

Types

type Event

type Event struct {
	// Name is the unique full name of the event.
	Name string `json:"name"`

	// Service represents the service that generates this event.  For example,
	// if this event documents an event from Stripe, this field is "stripe".
	Service string `json:"integration"`

	// Description is a short human description of the event.
	Description string `json:"description"`

	// Version represents the version of this event.  This allows for changing
	// event schemas over time.
	Version string `json:"version"`

	// Cue is the cue type definition of the event, without annotations.
	Cue string `json:"cue"`

	// Schema is the JSON schema definition of the event.
	Schema map[string]interface{} `json:"schema"`

	// TypeScript is the TypeScript definition of the event.
	TypeScript string `json:"typescript"`

	// Example are canonical example events to display in the UI.
	Examples []map[string]interface{} `json:"examples,omitempty"`
}

Event represents a single event payload. It is generated by parsing the cue definitions for each event within this repo.