Send Test Notification

Send Test Notification
Send Test Notification Scenario Config

Send Test Notification Scenario Config

Request
URI
POST
https://{vcfa-fqdn}/notification/api/scenario-configs/{scenarioId}/test
COPY
Path Parameters
string
scenarioId
Required  

Notification Scenario Id

Request Body
NotificationScenarioTestConfig of type(s) application/json
Required  

Show optional properties

{
    "recipient": "string"
}
{
    "data": {},
    "recipient": "string"
}
object
data
Optional

data

string
recipient
Required  

Recipient email

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Notification of type(s) application/json 
{
    "createdAt": "string",
    "createdBy": "string",
    "data": {},
    "groupRecipients": [
        "string"
    ],
    "id": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "recipients": [
        "string"
    ],
    "scenarioId": "string"
}
string As date-time As date-time
createdAt
Read-Only  

Creation time

string
createdBy
Read-Only  

Created By

object
data
Optional

data

array of string
groupRecipients
Optional

List of group recipients (max 10 groups, max 500 users/group will receive the notification)

string As uuid As uuid
id
Read-Only  

Notification id

string As date-time As date-time
lastUpdatedAt
Read-Only  

Update time

string
lastUpdatedBy
Read-Only  

Updated By

array of string
recipients
Optional

List of recipients (max 100 recipients)

string
scenarioId
Required  

Notification scenario id


400

Bad Request

Returns Notification of type(s) application/json 
{
    "createdAt": "string",
    "createdBy": "string",
    "data": {},
    "groupRecipients": [
        "string"
    ],
    "id": "string",
    "lastUpdatedAt": "string",
    "lastUpdatedBy": "string",
    "recipients": [
        "string"
    ],
    "scenarioId": "string"
}
string As date-time As date-time
createdAt
Read-Only  

Creation time

string
createdBy
Read-Only  

Created By

object
data
Optional

data

array of string
groupRecipients
Optional

List of group recipients (max 10 groups, max 500 users/group will receive the notification)

string As uuid As uuid
id
Read-Only  

Notification id

string As date-time As date-time
lastUpdatedAt
Read-Only  

Update time

string
lastUpdatedBy
Read-Only  

Updated By

array of string
recipients
Optional

List of recipients (max 100 recipients)

string
scenarioId
Required  

Notification scenario id


401

Unauthorized

Returns Notification of type(s) application/json 
"Notification Object"
string As date-time As date-time
createdAt
Read-Only  

Creation time

string
createdBy
Read-Only  

Created By

object
data
Optional

data

array of string
groupRecipients
Optional

List of group recipients (max 10 groups, max 500 users/group will receive the notification)

string As uuid As uuid
id
Read-Only  

Notification id

string As date-time As date-time
lastUpdatedAt
Read-Only  

Update time

string
lastUpdatedBy
Read-Only  

Updated By

array of string
recipients
Optional

List of recipients (max 100 recipients)

string
scenarioId
Required  

Notification scenario id


403

Forbidden

Returns Notification of type(s) application/json 
"Notification Object"
string As date-time As date-time
createdAt
Read-Only  

Creation time

string
createdBy
Read-Only  

Created By

object
data
Optional

data

array of string
groupRecipients
Optional

List of group recipients (max 10 groups, max 500 users/group will receive the notification)

string As uuid As uuid
id
Read-Only  

Notification id

string As date-time As date-time
lastUpdatedAt
Read-Only  

Update time

string
lastUpdatedBy
Read-Only  

Updated By

array of string
recipients
Optional

List of recipients (max 100 recipients)

string
scenarioId
Required  

Notification scenario id


404

Not Found

Returns Notification of type(s) application/json 
"Notification Object"
string As date-time As date-time
createdAt
Read-Only  

Creation time

string
createdBy
Read-Only  

Created By

object
data
Optional

data

array of string
groupRecipients
Optional

List of group recipients (max 10 groups, max 500 users/group will receive the notification)

string As uuid As uuid
id
Read-Only  

Notification id

string As date-time As date-time
lastUpdatedAt
Read-Only  

Update time

string
lastUpdatedBy
Read-Only  

Updated By

array of string
recipients
Optional

List of recipients (max 100 recipients)

string
scenarioId
Required  

Notification scenario id


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"recipient":"string"}' https://{api_host}/notification/api/scenario-configs/{scenarioId}/test
On This Page
Notification Scenario Configuration Operations
GET
Get All Scenario Configs
PATCH
Patch Config
POST
Create Or Update
DELETE
Delete
GET
Get Scenario Config
POST
Preview Notification Config
POST
Send Test Notification