Berichten

Notifies the respective party (e.g., a citizen or an organization) that the message with decision is available on their cities messagebox.

Notification

Example of JSON schema:

{
  "actie": "create",
  "kanaal": "objecten",
  "resource": "object",
  "kenmerken": {
    "objectType": "https://..."
  },
  "hoofdObject": "https://...",
  "resourceUrl": "https://...",
  "aanmaakdatum": "2000-01-01T10:00:00.000Z"
}

Environment variables

Required to be set:

ZGW_WHITELIST_MESSAGE_ALLOWED

ZGW_VARIABLE_OBJECTTYPE_MESSAGEOBJECTTYPE_UUID

NOTIFY_TEMPLATEID_EMAIL_MESSAGERECEIVED

NOTIFY_TEMPLATEID_SMS_MESSAGERECEIVED

5.2.7.3. Requirements

• The initial notification has:

  • Action: Create ("create")

  • Channel: Objects ("objecten")

  • Resource: Object ("object")

• The GUID from object type URI ("objectType") in the initial notification has to be whitelisted or "*" wildcard used (to accept all object types) in respective whitelist environment variable. This step will distinguish for which object type the notification is desired (e.g., tasks, messages, etc.)

• Sending of messages is allowed in respective environment variable

• All URIs are valid, source data complete, and JWT token or API keys correct

The notification will be processed and sent!

Otherwise, user will get a meaningful API feedback from OMC application explaining what exactly is missing.

5.2.7.4. Template placeholders

Required placeholders names in the Notify NL template:

((klant.voornaam))

((klant.voorvoegselAchternaam))

((klant.achternaam))

((message.onderwerp))

((message.handelingsperspectief))