Skip to content
aYOUne
← Configuration API

OnboardingTemplates

Singular: OnboardingTemplate — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "6ac21509c0aedf1dd2cdd8aa",
    "industry": "gesundheit",
    "active": true,
    "createdAt": "2026-10-04T08:57:45.296Z",
    "dashboardConfig": {
      "layout": "grid",
      "widgets": [
        {
          "type": "kpi",
          "metric": "displays.online",
          "title": "Bildschirme online"
        },
        {
          "type": "kpi",
          "metric": "ads.pending-approval",
          "title": "Werbemittel zur Freigabe"
        },
        {
          "type": "kpi",
          "metric": "appointments.today",
          "title": "Termine heute"
        },
        {
          "type": "list",
          "source": "service.tickets.open",
          "title": "Offene Kundenanliegen"
        }
      ]
    },
    "description": "Bildschirme im Wartebereich und Schaufenster mit Pollenflug, Öffnungszeiten, Gesundheits-Tipps der Saison und HWG-geprüften Angeboten — dazu Kundenkartei, Termine und Rechnungen.",
    "exampleWorkflows": [
      {
        "name": "HWG-Prüfung vor der Ausspielung",
        "trigger": "advertisement.created",
        "steps": [
          {
            "action": "ai-generate",
            "config": {
              "knowledgePackName": "Gesundheitsbranche — Datenschutz & Fachgrundlagen",
              "task": "hwg-check",
              "output": "review-note"
            }
          },
          {
            "action": "send-notification",
            "config": {
              "channels": [
                "internal_chat",
                "email"
              ],
              "template": "ad-approval-required"
            }
          }
        ]
      },
      {
        "name": "Erinnerung vor dem Termin",
        "trigger": "appointment.booked",
        "steps": [
          {
            "action": "wait",
            "config": {
              "hours": 24
            }
          },
          {
            "action": "send-notification",
            "config": {
              "channels": [
                "sms",
                "email"
              ],
              "template": "appointment-reminder"
            }
          }
        ]
      }
    ],
    "modules": [
      "crm",
      "sale",
      "payments",
      "marketing",
      "ads",
      "cms",
      "service",
      "automation",
      "reporting",
      "ai"
    ],
    "name": "Apotheken- & Praxis-Set",
    "updatedAt": "2026-10-04T08:57:45.296Z",
    "shares": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/onboardingtemplates/6ac21509c0aedf1dd2cdd8aa",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6adec7e562556e5404c0dc26",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_ONBOARDINGTEMPLATE",
        "href": "https://api.ayoune.app/config/onboardingtemplates/6ac21509c0aedf1dd2cdd8aa/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_ONBOARDINGTEMPLATE",
        "href": "https://api.ayoune.app/config/onboardingtemplates/6ac21509c0aedf1dd2cdd8aa",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "7010",
      "reset": "1792987338",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 185.385211,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /onboardingtemplates List with filters/pagination config.onboardingtemplates.view
GET /onboardingtemplates/:id Single record config.onboardingtemplates.view
POST /onboardingtemplates Create new record config.onboardingtemplates.new
PUT /onboardingtemplates Update record config.onboardingtemplates.edit
DELETE /onboardingtemplates/:id Delete record config.onboardingtemplates.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.config.onboardingTemplates.find().limit(10).exec();

// Single record
const one = await ay.config.onboardingTemplates.findById('OBJECT_ID').exec();

// Create
const created = await ay.config.onboardingTemplates.create({ name: 'Foo' });

See also