1. Home
  2. Docs
  3. API Documentation
  4. Integration
  5. UpdateSlack

UpdateSlack

Route: https://kayran.live/api/UpdateSlack

This function allow users to integrate and connect Slack to Kayran.

*For more information regarding the use of Slack, please go to our Support*

Request Syntax

{

"apiKey": "String",

"channelId": "String",

"slackToken": "String",

"slackAvgThreat": Informative/Low/Medium/High,

"slackNotify": true/false,

"slackStartFromSchedule": true/false,

"slackStartFromQueue": true/false,

"slackCompleteAborted":true/false,

"slackDelete":true/false,

"slackStop":true/false,

"slackAborted":true/false

}


Request Parameters

Parameters being used in the Request

Parameter Name :

apiKey

Parameter Usage and Options :

Your Kayran 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 Kayran 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.


Successful Response

 
{
    "Error": 0,
    "Function": "UpdateSlack",
    "Data": "Success"
}

Errors and their Possible Causes

For more information, please refer to the General Errors section.