Elements runtime reference / Side effects

`createNotification`

Append a notification side effect to Element runtime output.

Terug naar builtin index Signatuur Payloadformaat Voorbeeld Scope-notities

Signatuur

createNotification(payload=None, **kwargs)

Doel

Append a notification side effect to Element runtime output.

Aliases and imports

create_notification
yieldNotification
yield_notification
notify

Payloadformaat

Use these fields as the Python call arguments or keyword payload for this helper.

{
  "title": "Issue escalated",
  "body": "Review required",
  "recipientUids": [
    "user-123"
  ],
  "data": [
    {
      "id": "sample",
      "widget": "table",
      "data": [
        {
          "key": "value"
        }
      ]
    }
  ]
}

Field	Description
`payload`	Optional notification dict.
`title/body/description`	Notification display fields.
`userUid/userIds/recipientUids`	Recipient uid fields.
`data`	Optional datasets such as table payloads with id, title, widget, columns, and data rows.

Return payload

{
  "title": "Issue escalated",
  "body": "Review required",
  "recipientUids": [
    "user-123"
  ],
  "data": [
    {
      "id": "sample",
      "widget": "table",
      "data": [
        {
          "key": "value"
        }
      ]
    }
  ]
}

Voorbeeld

def run():
    createNotification(
        title="Issue escalated",
        body="Review required",
        data=[{"id": "sample", "widget": "table", "data": [{"key": "value"}]}],
    )
    return {"notified": True}

Scope-notities

If recipients are omitted and context.actor.uid exists, the actor can become the default recipient.

createNotification