Create Event Template

Overview

The Arianee event template allows brands to create standardized templates for topical events related to product lifecycle. These templates can be reused for various events, such as repair, and maintenance, ensuring consistency and efficiency in event management.

Let's start 🚀

URL

Required rights: admin or certCreate

To create an event template, use the /arianeeEventTemplate.

POST - https://{{nmpUrl}}/arianeeEventTemplate

Body

FieldTypeRequiredDescription
metadataObjectContains additional information about the event template.
nameStringThe display name of the event template. Example: "Repair Event".
iconStringA URL pointing to an icon that visually represents the event template.
contentStringContains the core event information respecting the Event Schema.
{
  "deleted": false,
  "metadata": {
    "name": "Service Event",
    "icon": "https://img.freepik.com/vecteurs-premium/vecteur-conception-modele-logo-service_20029-568.jpg"
  },
  "content": "{\"eventType\":\"repair\",\"language\":\"fr-FR\",\"title\":\"Repair done\",\"description\":\"Your product has been repaired and is now operational.\",\"i18n\":[],\"$schema\":\"https://cert.arianee.org/version1/ArianeeEvent-i18n.json\"}"
}

Return Payload

Status CodeSuccessDescription
200trueThe event template has been created.
{
  "deleted": false,
  "metadata": {
    "name": "Evenement de Service",
    "icon": "https://img.freepik.com/vecteurs-premium/vecteur-conception-modele-logo-service_20029-568.jpg"
  },
  "content": "{\"eventType\":\"repair\",\"language\":\"fr-FR\",\"title\":\"Repair done\",\"description\":\"Your product has been repaired and is now operational.\",\"i18n\":[],\"$schema\":\"https://cert.arianee.org/version1/ArianeeEvent-i18n.json\"}"
}