Route: https://api.cytrix.io/UpdateSlack
This function allow users to integrate and connect Slack to CYTRIX.
*For more information regarding the use of Slack, please go to our Support*
Roles Required: Admin.
Request Syntax
{
"apiKey": "String",
"channelId": "String",
"slackToken": "String",
"slackNotify": true/false,
"slackStartFromSchedule": true/false,
"slackStartFromQueue": true/false,
"slackCompleteAborted": true/false,
"slackDelete": true/false,
"slackStop": true/false,
"slackAborted": true/false,
"slackPause": true/false,
"slackUnpause": true/false
"on_high": True/False,
"on_medium": True/False,
"on_low": True/False,
"on_informative": True/False
}
Request Parameters
Parameters being used in the Request
Parameter Name :
apiKey
Parameter Usage and Options :
Your CYTRIX given API Key.
How do I get it ? :
Located in the “Profile” section.
Note : by default, the “API Status” is enabled, unless, the Admin has disabled it in the “Server Settings” section.
Type :
String
Is it Optional ? :
No.
Parameter Name :
channelId
Parameter Usage and Options :
The ID of your Slack’s channel.
Type :
String
Is it Optional ? :
No.
Parameter Name :
slackToken
Parameter Usage and Options :
The OAuth Token of your Slack’s channel.
Type :
String
Is it Optional ? :
No.
Parameter Name :
slackAvgThreat
Parameter Usage and Options :
Users can choose to get notified based on the average severity of the vulnerabilities CYTRIX has detected.
Value:
Informative/Low/Medium/High
Is it Optional ? :
Yes.
Parameter Name :
slackNotify
Parameter Usage and Options :
Enabling it means that you will get notified on all possible events.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
slackStartFromSchedule
Parameter Usage and Options :
Enabling it means that you will get notified on scheduled scans that gets initiated.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
slackStartFromQueue
Parameter Usage and Options :
Enabling it means that you will get notified on queued scans that gets initiated.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
slackCompleteAborted
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were finished and are either completed or aborted.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
slackDelete
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were deleted.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
slackStop
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were stopped.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
Parameter Name :
slackAborted
Parameter Usage and Options :
Enabling it means that you will get notified on scans that were aborted.
Type:
Boolean – true / false
Is it Optional ? :
Yes.
slackPause
Parameter Name:
slackPause
Parameter Usage and Options:
Enabling it means that you will get notified when scans are paused.
Type:
Boolean – true / false
Is it Optional?:
Yes.
slackUnpause
Parameter Name:
slackUnpause
Parameter Usage and Options:
Enabling it means that you will get notified when scans are resumed after being paused.
Type:
Boolean – true / false
Is it Optional?:
Yes.
Parameter Name :
on_high
Parameter Usage and Options :
Enabling the on_high toggle ensures that you receive notifications for vulnerabilities classified as High severity during scans.
Type:
Boolean – True / False
Is it Optional ? :
No.
Parameter Name :
on_medium
Parameter Usage and Options :
Enabling the on_medium toggle ensures that you receive notifications for vulnerabilities classified as Medium severity during scans.
Type:
Boolean – True / False
Is it Optional ? :
No.
Parameter Name :
on_low
Parameter Usage and Options :
Enabling the on_low toggle ensures that you receive notifications for vulnerabilities classified as Low severity during scans.
Type:
Boolean – True / False
Is it Optional ? :
No.
Parameter Name :
on_informative
Parameter Usage and Options :
Enabling the on_informative toggle ensures that you receive notifications for vulnerabilities classified as Informative severity during scans.
Type:
Boolean – True / False
Is it Optional ? :
No.
Successful Response
{
"Error": 0,
"Function": "UpdateSlack",
"Data": "Success"
}
Errors and their Possible Causes
For more information, please refer to the General Errors section.