Notification
Manage User Notification Channels.
Create
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type | Required |
|---|---|---|
| channel | string | |
| data | string | |
| destination | string | |
| enable | boolean | |
| format | string | |
| headers | object | |
| method | string | |
| name | string | yes |
| region | string |
Response
| Field | Type |
|---|---|
| accountId | string |
| channel | string |
| data | string |
| destination | string |
| enable | boolean |
| format | string |
| headers | object |
| id | string |
| method | string |
| name | string |
| region | string |
Find
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| type | string |
Query String Options
| Field | Type |
|---|---|
| hidden | boolean |
| filter | string |
| limit | number |
| next | object |
| prev | object |
| index | string |
| where | string |
| log | boolean |
Response
Paged response.
| Field | Type | Notes |
|---|---|---|
| data | array | An array of metrics each containing an array of metric with the following properties. |
| next | string | Paged cursor to use for the next page of items. |
| prev | string | Pages cursor to use for the previous page of items. |
Notification
An array of Notification items.
| Field | Type |
|---|---|
| accountId | string |
| channel | string |
| data | string |
| destination | string |
| enable | boolean |
| format | string |
| headers | object |
| id | string |
| method | string |
| name | string |
| region | string |
Get
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| id | string |
Response
| Field | Type |
|---|---|
| accountId | string |
| channel | string |
| data | string |
| destination | string |
| enable | boolean |
| format | string |
| headers | object |
| id | string |
| method | string |
| name | string |
| region | string |
Init
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
A object.
Response
| Field | Type |
|---|---|
| accountId | string |
| channel | string |
| data | string |
| destination | string |
| enable | boolean |
| format | string |
| headers | object |
| id | string |
| method | string |
| name | string |
| region | string |
Remove
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| id | string |
Update
Endpoint
1 | |
Authorized User Role
1 | |
Request Body
| Field | Type |
|---|---|
| channel | string |
| data | string |
| destination | string |
| enable | boolean |
| format | string |
| headers | object |
| id | string |
| method | string |
| name | string |
| region | string |
Response
| Field | Type |
|---|---|
| accountId | string |
| channel | string |
| data | string |
| destination | string |
| enable | boolean |
| format | string |
| headers | object |
| id | string |
| method | string |
| name | string |
| region | string |