Proxies POST requests to Forge realtime services for publishing events. All clients in the same context as the sender and subscribed to this realtime channel will receive the event. "Publish" requests only work when the request originated from a UI context invocation. In the forge-proxy-authorization header you must specify the id of the invocation; you can't perform operations on behalf of an installationId.

Forge and OAuth2 apps cannot access this REST resource.

Request

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

Event data to be published

name

string

Required

payload

string

Required

options

object

Responses

Realtime message published successfully

application/json

object

POST/forge/realtime/v1/publish

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/forge/realtime/v1/publish' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "forge-container-realtime-channel",
  "payload": "Realtime message sent from the container service, id=1",
  "options": {
    "token": "example-token"
  }
}'

POST

Publish an event to a global realtime channel

Proxies POST requests to Forge realtime services for publishing events. All clients subscribed to this global realtime channel will receive the event.

Forge and OAuth2 apps cannot access this REST resource.

Request

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

name

string

Required

payload

string

Required

options

object

Responses

Global realtime message published successfully

application/json

object

POST/forge/realtime/v1/publish/global

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/forge/realtime/v1/publish/global' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "forge-container-realtime-channel",
  "payload": "Realtime message sent from the container service, id=1"
}'

POST

Sign a forge realtime token

Signs a forge realtime token that can be used to securely publish events to realtime channels.

Forge and OAuth2 apps cannot access this REST resource.

Request

Header parameters

forge-proxy-authorization

string

Required

Content-Type

string

Request bodyapplication/json

channelName

string

Required

claims

object

Required

Responses

Realtime token signed successfully

application/json

object

POST/forge/realtime/v1/token

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url '{FORGE_EGRESS_PROXY_URL}/forge/realtime/v1/token' \
  --header 'Accept: application/json' \
  --header 'forge-proxy-authorization: Forge as=app,id=invocation-123' \
  --header 'Content-Type: application/json' \
  --data '{
  "channelName": "forge-container-realtime-channel",
  "claims": {
    "allowedUsers": [
      "user1",
      "user2"
    ]
  }
}'