Send Test Notification

• Notification Scenario Configuration

Send Test Notification Scenario Config

Request

URI

POST

https://{api_host}/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.

bearerAuth

Responses

200

Hide Details

OK

Returns Notification of type(s) application/json

"Notification Object"

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

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

Optional

Notification id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

array of string

recipients

Optional

List of recipients (max 100 recipients)

string

scenarioId

Required

Notification scenario id

400

Hide Details

Bad Request

Returns Notification of type(s) application/json

"Notification Object"

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

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

Optional

Notification id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

array of string

recipients

Optional

List of recipients (max 100 recipients)

string

scenarioId

Required

Notification scenario id

401

Hide Details

Unauthorized

Returns Notification of type(s) application/json

"Notification Object"

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

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

Optional

Notification id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

array of string

recipients

Optional

List of recipients (max 100 recipients)

string

scenarioId

Required

Notification scenario id

403

Hide Details

Forbidden

Returns Notification of type(s) application/json

"Notification Object"

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

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

Optional

Notification id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

Updated By

array of string

recipients

Optional

List of recipients (max 100 recipients)

string

scenarioId

Required

Notification scenario id

404

Hide Details

Not Found

Returns Notification of type(s) application/json

"Notification Object"

string As date-time As date-time

createdAt

Optional

Creation time

string

createdBy

Optional

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

Optional

Notification id

string As date-time As date-time

lastUpdatedAt

Optional

Update time

string

lastUpdatedBy

Optional

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

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

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