AVKUL ERPDocs
MODULE GUIDE · 11 OCT 2026

Notifications & integrations

Review notifications, integration settings, webhook records and shared AI request state.

Try guided demo →Download guide ↓
Notifications & integrations — illustrated workflow banner
OVERVIEW

What you can do

01

In-app notifications

02

Integration status

03

Integration configuration

04

Webhooks

05

AI requests

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

  • An assigned school account with the required permissions.
  • The academic, student or staff setup used by this workflow.
Required permission keys
dashboard:viewcommunication:createsettings:viewsettings:createsettings:updatesettings:delete

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

STEP BY STEP

How the workflow works

  1. 01

    Open the relevant integration or notification view

    An assigned school account with the required permissions.

  2. 02

    Review status and permitted settings

    Integration status is part of the documented workflow.

  3. 03

    Configure a provider using approved credentials outside public documentation

    Integration configuration is part of the documented workflow.

  4. 04

    Use a controlled test and inspect the actual result

    Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

FieldDeclared typeInput
titlestringRequired by declaration
bodystringOptional
userIdstringOptional
channelstringOptional
dataJsonRecord<string, unknown>Optional
featurestringRequired by declaration
providerstringRequired by declaration
modelstringOptional
promptJsonRecord<string, unknown>Optional
responseJsonRecord<string, unknown>Optional
promptTokensnumberOptional
completionTokensnumberOptional
statusstringOptional
errorMessagestringOptional
promptstringRequired by declaration
categorystringOptional
configJsonRecord<string, unknown>Optional
secretsRefstringOptional
isActivebooleanOptional
integrationIdstringOptional
eventstringRequired by declaration
targetUrlstringRequired by declaration
secretstringOptional
CURRENT BEHAVIOUR

Rules & current limits

  • Saving settings is not proof of external delivery. No credential values are included in this documentation.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

LEARN BY DOING

Try notifications & integrations

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →
FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

17 source-declared operations
GET/api/v1/notifications

List My Notifications

dashboard:view
POST/api/v1/notifications

Create Notification

communication:create

Declared request fields: title (required), body (optional), userId (optional), channel (optional), dataJson (optional).

POST/api/v1/notifications/:id/read

Mark Read

dashboard:view
GET/api/v1/ai/requests

List Ai Requests

dashboard:view
POST/api/v1/ai/requests

Log Ai Request

dashboard:view

Declared request fields: feature (required), provider (optional), model (optional), promptJson (optional).

PATCH/api/v1/ai/requests/:id/complete

Complete Ai Request

dashboard:view

Declared request fields: responseJson (optional), promptTokens (optional), completionTokens (optional), status (optional), errorMessage (optional).

POST/api/v1/ai/generate

Generate Ai

dashboard:view

Declared request fields: feature (required), prompt (required).

GET/api/v1/integrations/status

Integration Status

settings:view
GET/api/v1/integrations

List Integrations

settings:view
POST/api/v1/integrations

Create Integration

settings:create

Declared request fields: provider (required), category (optional), configJson (optional), secretsRef (optional).

PATCH/api/v1/integrations/:id

Update Integration

settings:update

Declared request fields: status (optional), isActive (optional).

DELETE/api/v1/integrations/:id

Remove Integration

settings:delete
GET/api/v1/webhooks

List Webhooks

settings:view
POST/api/v1/webhooks

Create Webhook

settings:create

Declared request fields: integrationId (optional), event (required), targetUrl (required), secret (optional).

PATCH/api/v1/webhooks/:id

Update Webhook

settings:update

Declared request fields: isActive (optional).

POST/api/v1/webhooks/:id/test

Test Webhook

settings:update
DELETE/api/v1/webhooks/:id

Remove Webhook

settings:delete

Open the actual application

ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.

/en/school/integrationsOpen ↗

Keep exploring

Screen guideNotifications & integrations →