Okta Partners

Publish an instant message

POST https://getokta.io/api/apps/realtime/publish

Pushes a message to your app's channel in this tenant only. Listening needs no scope — the installation is the permission, and there is no `realtime.messages.read`.

  • Rate Limit: MODERATE
    How heavily this call counts against your quota: LIGHT < MODERATE < HEAVY.
  • Permission needed: realtime.messages.write
    The scope the tenant must grant your app before this call is allowed.
  • Reference Code: srv_c59d
    A stable identifier for this endpoint — quote it to support to speed up tracing.

Body Params

event string required

Your own event name — `^[a-z][a-z0-9_.:-]{0,63}$`. It never becomes the broadcast event name: that is the fixed `app.message`, and yours travels inside the payload.

data object required

The message payload, at most 8192 bytes of JSON. Anything needing data is read by the surface from the API with its usual scope.