Get Effect Types Documentation

GET/eventTypes/effect-types

Lists the kinds of output an effect can produce, such as notifications and activities, with each one's display name, description, the event windows (Draft, Active) it runs in, whether it is reversible, and its arguments. The list is the same for every event type, which is why it is not under a type id. Use it to build the output picker for EventTypes_CreateEventTypeEffect. Requires organization admin.

Response

Type: GetEffectTypeResponse[]

GetEffectTypeResponse

Field	Type	Description
type	string\| null
displayName	string\| null
description	string\| null
windows	string[]\| null
reversibility	string\| null
arguments	GetEffectTypeResponseArgumentInfo[]\| null

GetEffectTypeResponseArgumentInfo

Field	Type	Description
key	string\| null
label	string\| null
isRequired	boolean
valueKind	string\| null
acceptedAttributeTypes	string[]\| null