Module: notification_template

Enumeration: NotificationTemplateType

Notification Templates types Every new Enum added to this list, must be also added to 'notification_templates' table 'type' column

hub	1
push	2
email	3
phone	4
webhook	5

Struct: NotificationTemplate

Key	Field	Type	Description	Requiredness	Default value
1	id	string		default
2	teamId	string		default
3	label	string		default
4	type	NotificationTemplateType		default
5	payload	string		default
6	createdAt	i64		default
7	updatedAt	i64		default
8	archivedAt	i64		default
100	attributes	list<abac.AbacAttribute>		optional

Struct: NotificationTemplateField

Key	Field	Type	Description	Requiredness	Default value
1	id	string		default
2	notificationTemplateId	string		default
3	ownerId	string		default
4	notificationTemplate	NotificationTemplate		optional
5	references	list<reference.Reference>		default
6	createdAt	i64		default
7	updatedAt	i64		default
8	targets	list<reference.Target>		default

Struct: ReferenceableNotificationOp

Key	Field	Type	Description	Requiredness	Default value
1	op	notification_event.NotificationOp		default
2	placeholders	list<reference.Placeholder>		default

Struct: Source

Key	Field	Type	Description	Requiredness	Default value
1	jobId	string		default
2	jobBaseStepId	string		default
3	fieldId	string		default
4	clientId	string		default

Struct: NotificationParams

Key	Field	Type	Description	Requiredness	Default value
1	attributes	list<abac.AbacAttribute>		optional

Function: NotificationTemplateService.create

string create(string teamId,
              string label,
              NotificationTemplateType type,
              ReferenceableNotificationOp payload,
              NotificationParams notificationParams)
    throws common.SystemException

Create a new Notification Template

Function: NotificationTemplateService.createReference

string createReference(string notificationTemplateId,
                       string fieldId,
                       list<reference.Reference> references,
                       list<reference.Target> targets)
    throws common.SystemException

Function: NotificationTemplateService.notify

list<notification_event.NotificationEvent> notify(string teamId,
                                                  Source source)
    throws common.SystemException

Sends a notificationEvent to Notifications backend

Function: NotificationTemplateService.index

list<NotificationTemplate> index(string teamId)
    throws common.SystemException

Function: NotificationTemplateService.get

NotificationTemplate get(string teamId,
                         string notificationTemplateId)
    throws common.SystemException

Get a Notification Template by id

Function: NotificationTemplateService.deleteReference

void deleteReference(string teamId,
                     string notificationTemplateFieldId)
    throws common.SystemException

Delete a single one given link between a NotificationTemplate and a Field

Function: NotificationTemplateService.deleteReferences

void deleteReferences(string teamId,
                      string fieldId)
    throws common.SystemException

Delete all Notification Templates that are linked to a Field

Function: NotificationTemplateService.update

void update(string teamId,
            string notificationTemplateId,
            string label,
            ReferenceableNotificationOp payload,
            NotificationParams notificationParams)
    throws common.SystemException

Update a Notification Template

Function: NotificationTemplateService.archive

void archive(string teamId,
             string notificationTemplateId)
    throws common.SystemException

Function: NotificationTemplateService.unarchive

void unarchive(string teamId,
               string notificationTemplateId)
    throws common.SystemException

Function: NotificationTemplateService.duplicate

string duplicate(string teamId,
                 string notificationTemplateId)
    throws common.SystemException

Function: NotificationTemplateService.updateAttribute

list<abac.AbacAttribute> updateAttribute(common.UUID templateId,
                                         string attributeId,
                                         list<abac.AbacAttributeValue> values,
                                         abac.AbacUploadBehaviour behave)
    throws common.SystemException

Update a single attribute on a notification template return value will always be a list with a single attribute determined by which attribute was updated param templateId: integration template to update param attributeId: the AttributeId of the team level attribute to be updated param values: the new AttributeValues to associated with Attribute attributeId on Integration Template templateId param behave: determine the behaviour of the endpoint, merge or clobber. Default: clobber