Skip to content
FractalOps

Trigger Portal Notification Test

POST
/v1/portal/notifications/test
curl --request POST \
  --url 'https://example.com/v1/portal/notifications/test?tenant_id=' \
  --header 'Content-Type: application/json' \
  --data '{ "title": "FractalOps test notification", "body": "Notification center and web push wiring are live.", "href": "/", "level": "info", "source": "portal.notification.test", "workflow_id": "" }'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
tenant_id
Tenant Id
string
""

Header Parameters

Section titled “Header Parameters”
X-FractalOps-Tenant-Id
Any of:
string
x-pomerium-jwt-assertion
Any of:
string

Request Body

Section titled “Request Body”
Media typeapplication/json
PortalNotificationTestIn
object
title
Title
string
default: FractalOps test notification
body
Body
string
default: Notification center and web push wiring are live.
href
Href
string
default: /
level
Level
string
default: info
source
Source
string
default: portal.notification.test
workflow_id
Workflow Id
string
""

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
PortalNotificationTestOut
object
ok
Ok
boolean
workflow_id
Workflow Id
string
""
subscriber_id
Subscriber Id
string
""
acknowledged
Acknowledged
boolean
transaction_id
Transaction Id
string
""
Example
{
  "ok": false,
  "workflow_id": "",
  "subscriber_id": "",
  "acknowledged": false,
  "transaction_id": ""
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}