output.coms

The output file activated by the callback

type	object
properties
allowedTransmissionMode	The transmission mode allow to trigger a notification on the value change. Default value is [[“CHANGE”]]
	type	array
	default	CHANGE
	items	type	string
		enum	INITIALIZATION, RETRANSMISSION, CHANGE
isTemplateGeneratedByOspComposer	Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.
	type	string
notificationId	The notification ID to trigger when the output is activated.
	type	string
targets	The targets were to send the notification on value change. Default value is [[]]
	type	array
	default
	items	TargetConfiguration
templateId	The id of the template to use for this file
	type	string
templateVariables	The variables and their values to be replaced from the template
	type	object
	additionalProperties
variablesFiles	The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.
	type	array
	items	type	string
additionalProperties	False

TargetConfiguration

type	object
properties
originator	Origin of the notification (~=sender)
	OriginatorConfiguration
providers	The list of the providers to use to send this notification
	type	array
	items	SenderConfiguration
recipient	The recipients of the notification
	oneOf	FROM_COLLECTION_MODULE
		FROM_KEYCLOAK_GROUP
		FROM_STATIC_LIST
additionalProperties	False

OriginatorConfiguration

type	object
properties
emailSender	The sender of the EMAIL. Example NO_REPLY@info.com (some limitations of the mail server can apply). Can be not set if no EMAIL configuration is used
	Email
smsSender	The sending number (some limitations by the provider can apply). Can be not set if no SMS configuration is used
	type	string
additionalProperties	False

Email

type	object
properties
email	The address email. For example no-reply@company.com.
	type	string
name	The name to use on the from field. For example, ‘NO REPLY’ will generate ‘NO REPLY <no-reply@company.com>’)
	type	string
additionalProperties	False

SenderConfiguration

type	object
properties
backup	When a notification fails on the first provider, this provider is chosen for sending the notification. To prevent an infinite loop, the system ensures that if a provider has already been utilized to send this particular notification, it will not be selected again
	SenderConfiguration
providerId	The ID of the provider to use.
	type	string
retry	The number of retry before using the backup as fallback. Be warned that notification are runtime so in case of reboot of themodule notification are lost. Default value is [3]
	type	integer
	default	3
retryDelay	The delay between each retry. Default value is [{“unit”:”SECONDS”,”value”:10}]
	default	unit	SECONDS
		value	10
	DurationConfigurationEntity
additionalProperties	False

DurationConfigurationEntity

type	object
properties
unit	The unit of time expressed
	type	string
	enum	NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS
value	The amount of time expressed with the unit
	type	integer
additionalProperties	False

FROM_COLLECTION_MODULE

type	object
properties
type	type	string
	enum	FROM_COLLECTION_MODULE
	default	FROM_COLLECTION_MODULE
collectionFilter	The ID of the filter to use on the collection.
	type	string
collectionId	The ID of the collection containing the contacts. See collection module to more information.
	type	string
additionalProperties	False

FROM_KEYCLOAK_GROUP

type	object
properties
type	type	string
	enum	FROM_KEYCLOAK_GROUP
	default	FROM_KEYCLOAK_GROUP
wantedGroups	The list of the group of users to notify. A empty list will use all groups.
	type	array
	items	type	string
additionalProperties	False

FROM_STATIC_LIST

type	object
properties
type	type	string
	enum	FROM_STATIC_LIST
	default	FROM_STATIC_LIST
contactsId	The contact ID to notify
	type	string
additionalProperties	False