Create a template for notification.
POST {{baseUrl}}/templates
Create a new template definition for sending notifications. Templates can be created for Email, SMS and PUSH type of notifications. When providing templates, the place holders defined in the templates need to be specified as params in the api metadata attribute. Provided below is a sample template for reference.
Dear PlantEngineer,
The regular maintenance of the machines is completed for %FactoryName%. Please plan to start the assembly line.
Kind regards,
Maintenance Engineer
While creating a template definition for the above sample template, provide FactoryName as params in metadata attribute.
The maximum size of the email template is limited to 8 MB. However, the email message resulting from the Email template along with its attachments is limited by the email size limit; i.e. 8 MB.
In case of SMS, the sms message resulting from the template is limited to maximum size of SMS notification; i.e. 1500 bytes.
The following table lists the supported filetypes for various notifications:
| Notification type | Supported filetypes |
|---|---|
.html, .txt | |
| SMS | .txt |
| Push | *.json |
Templates for Push notification should follow the model as described in definitions/PushMessageModel.
Request Body
[{"name"=>"metadata", "value"=>"<json>", "datatype"=>"string"}, {"name"=>"templateFile", "value"=>nil, "datatype"=>"null"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"name":"FactoryAlertTemplate","type":"SMS","id":"0bff7e7a-cd25-4576-9908-4180ef086174","templateFileName":"FactoryNotificationTemplate.html","params":[{"sunta":{},"fugiat7":{},"ea86":{},"ex7":{},"veniam_30":{},"Lorem_e0":{},"irure0":{},"cillum_9":{},"esse_8":{},"quia":{},"doec":{},"elit_68c":{},"dolorf1":{}},{"id_ed1":{},"sinte_":{},"laborea01":{},"nostrud_46":{},"aliqua1dd":{},"aliquip60":{},"consectetur0":{},"sede":{},"nulla_d":{},"quis_0a0":{},"do_":{},"irure_315":{},"ut_e":{},"ut2":{},"nisi39":{},"ut8":{},"enim_f":{},"esse_36":{},"eu_b":{},"Excepteur4":{},"occaecate6":{},"occaecat_52":{},"voluptate_e":{},"laboris_6e0":{},"nulla_d8d":{},"enim8":{},"aliquip_09f":{},"adipisicing_e9e":{},"aliquipd":{},"in_d1d":{}}],"eTag":"1"}