- Create Channel
- Get Channels
- Get Channel
- Get Channel List
- Update Channel
- Delete Channel
POST /api/v1/integration/channelCreates a notification or secrets channel, such as Slack, Teams, Google Chat or a vault integration.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
Display name.
string
Free-text description.
string
ID of the channel type, for example Slack or Google Chat.
boolean
Whether the object is active.
boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
The endpoint’s response payload.
curl -X POST "https://<your-workspace>.prizmdata.ai/api/v1/integration/channel" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Data Quality Alerts",
"description": "Slack channel for quality alerts",
"channel_type_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
"configuration": {
"webhook_url": "<webhook-url>"
},
"is_active": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"name": "Data Quality Alerts",
"description": "Slack channel for quality alerts",
"channel_type_id": "6bec0bfd-d228-593f-bff0-4b52308f0489",
"configuration": {
"webhook_url": "<webhook-url>"
},
"is_active": true
}
Response
{
"success": true,
"message": "Create Channel",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
GET /api/v1/integration/channelGet all configured channels from the database.Responseboolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/integration/channel" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Get all configured channels from the database.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
GET /api/v1/integration/channel/{channelId}Get a channel by its ID.Path Parametersstring
required
ID of the channel.
boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
string
Example:
"cbafb3b2-9175-543a-9fc4-d2817b76de29".string
Example:
"AWS Vault".string
string
Example:
"vault".string
Example:
"aws_secrets_manager".boolean
Example:
true.object
string
string
Example:
"2026-08-16T13:08:30.903564Z".string
Example:
"491be29a-189c-5539-b9c2-6f4f7dc7972a".string
Example:
"2026-08-18T13:27:46.306915Z".string
Example:
"491be29a-189c-5539-b9c2-6f4f7dc7972a".string
Example:
"6427a6ee-3ac6-546b-91f0-f42990ded81c".curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/integration/channel/{channelId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Get a channel by its ID.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {
"id": "cbafb3b2-9175-543a-9fc4-d2817b76de29",
"name": "AWS Vault",
"description": null,
"tag": "vault",
"qualified_name": "aws_secrets_manager",
"is_active": true,
"configuration": {
"name": "AWS Vault",
"region": "us-east-1",
"auth_type": "access key and secret key",
"description": null,
"awsaccesskey": "<AWS_ACCESS_KEY_ID>",
"awssecretaccesskey": "<AWS_SECRET_ACCESS_KEY>"
},
"is_valid": null,
"created_at": "2026-08-16T13:08:30.903564Z",
"created_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
"updated_at": "2026-08-18T13:27:46.306915Z",
"updated_by": "491be29a-189c-5539-b9c2-6f4f7dc7972a",
"channel_type_id": "6427a6ee-3ac6-546b-91f0-f42990ded81c"
}
}
GET /api/v1/integration/channel/channel_listGet list of channels from Slack, Teams, and Google Chat using access_token.Responseboolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
curl -X GET "https://<your-workspace>.prizmdata.ai/api/v1/integration/channel/channel_list" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Get list of channels from Slack, Teams, and Google Chat using access_token.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
PUT /api/v1/integration/channel/{channelId}Update a channel configuration.Request BodyField descriptions are inferred from the entity model. Which fields are required is not confirmed for this endpoint.string
Display name.
string
Free-text description.
boolean
Whether the object is active.
string
required
ID of the channel.
boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
The endpoint’s response payload.
curl -X PUT "https://<your-workspace>.prizmdata.ai/api/v1/integration/channel/{channelId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"name": "Data Quality Alerts",
"description": "Slack channel for quality and freshness alerts",
"is_active": true
}'
Representative request body. Field names follow the corresponding entity model and values are illustrative; send only the fields you need.
Request body
{
"name": "Data Quality Alerts",
"description": "Slack channel for quality and freshness alerts",
"is_active": true
}
Response
{
"success": true,
"message": "Update a channel configuration.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}
DELETE /api/v1/integration/channel/{channelId}Delete a channel by its ID.Path Parametersstring
required
ID of the channel.
boolean
Whether the request completed successfully
string
Human-readable result message
string
ISO 8601 server timestamp
string
Unique ID for this request
object
The endpoint’s response payload.
curl -X DELETE "https://<your-workspace>.prizmdata.ai/api/v1/integration/channel/{channelId}" \
-H "Authorization: Bearer <YOUR_API_TOKEN>"
Response
{
"success": true,
"message": "Delete a channel by its ID.",
"timestamp": "2026-09-21T09:43:50.316067+00:00",
"correlation_id": "1bff0823-3db2-4b12-bf56-22ea8d38bba2",
"data": {}
}