Type Alias: CustomEventRequirement

@torque-labs/torque-utils • Docs

---

@torque-labs/torque-utils / CustomEventRequirement

Type Alias: CustomEventRequirement

type CustomEventRequirement: {
  requirement: CustomEventConfigSchema;
  type: CUSTOM_EVENT;
};

Custom event requirement type

Type declaration

Name	Type	Default value	Description
requirement	{ description: null | string; eventName: string; fields: ({ description: null | string; image: null | string; label: null | string; name: string; } & { type: "string"; validation: { match: null | string; required: null | boolean; }; } | { description: null | string; image: null | string; label: null | string; name: string; } & { type: "number"; validation: { max: null | number; min: null | number; }; } | { description: null | string; image: null | string; label: null | string; name: string; } & { type: "boolean"; validation: { match: null | boolean; }; })[]; formEnabled: boolean; targetUrl: null | string; }	CustomEventConfigSchema	-
requirement.description?	null | string	-	A short description to the user of the custom event
requirement.eventName	string	-	The name of the custom event that will be used in the POST request to the API
requirement.fields	({ description: null | string; image: null | string; label: null | string; name: string; } & { type: "string"; validation: { match: null | string; required: null | boolean; }; } | { description: null | string; image: null | string; label: null | string; name: string; } & { type: "number"; validation: { max: null | number; min: null | number; }; } | { description: null | string; image: null | string; label: null | string; name: string; } & { type: "boolean"; validation: { match: null | boolean; }; })[]	-	Array of custom event property fields and the validation
requirement.formEnabled	boolean	-	Depreceated: Whether it's enabled as a form directly in the UI NOTE: This is depreceated. Use FORM_SUBMISSION instead
requirement.targetUrl?	null | string	-	The target URL for more information, or where the requirement can be completed
type	CUSTOM_EVENT	-	-

Defined in

types/eventConfig/config.ts:70