Slack Setting

List all the Slack settings endpoints

Get the list of all your slack settings

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the slack setting

namestringRequired

The slack setting name

webHookUrlstringRequired

The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)

channelstringRequired

The slack setting channel name

userNamestringRequired

The slack setting channel username

403

Invalid credentials

500

Internal Server Error

application/json

get/v3/slackSetting

HTTPcURLJavaScriptPython

GET /v3/slackSetting HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "webHookUrl": "text",
    "channel": "text",
    "userName": "text"
  }
]

Create a slack setting

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

idstringRead-onlyRequired

The ID of the slack setting

namestringRequired

The slack setting name

webHookUrlstringRequired

The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)

channelstringRequired

The slack setting channel name

userNamestringRequired

The slack setting channel username

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the slack setting

namestringRequired

The slack setting name

webHookUrlstringRequired

The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)

channelstringRequired

The slack setting channel name

userNamestringRequired

The slack setting channel username

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post/v3/slackSetting

HTTPcURLJavaScriptPython

POST /v3/slackSetting HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "text",
  "webHookUrl": "text",
  "channel": "text",
  "userName": "text"
}

[
  {
    "id": "text",
    "name": "text",
    "webHookUrl": "text",
    "channel": "text",
    "userName": "text"
  }
]

Get a single slack setting

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

slackSettingIdstringRequired

The Id of the slack setting

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the slack setting

namestringRequired

The slack setting name

webHookUrlstringRequired

The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)

channelstringRequired

The slack setting channel name

userNamestringRequired

The slack setting channel username

403

Invalid credentials

404

Invalid slackSettingId

500

Internal Server Error

application/json

get/v3/slackSetting/{slackSettingId}

HTTPcURLJavaScriptPython

GET /v3/slackSetting/{slackSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "webHookUrl": "text",
    "channel": "text",
    "userName": "text"
  }
]

Update a slack setting

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

slackSettingIdstringRequired

The Id of the slack setting

Body

application/json

idstringRead-onlyRequired

The ID of the slack setting

namestringRequired

The slack setting name

webHookUrlstringRequired

The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)

channelstringRequired

The slack setting channel name

userNamestringRequired

The slack setting channel username

Responses

200

OK

application/json

idstringRead-onlyRequired

The ID of the slack setting

namestringRequired

The slack setting name

webHookUrlstringRequired

The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)

channelstringRequired

The slack setting channel name

userNamestringRequired

The slack setting channel username

403

Invalid credentials

404

Invalid slackSettingId

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

application/json

put/v3/slackSetting/{slackSettingId}

HTTPcURLJavaScriptPython

PUT /v3/slackSetting/{slackSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "text",
  "webHookUrl": "text",
  "channel": "text",
  "userName": "text"
}

[
  {
    "id": "text",
    "name": "text",
    "webHookUrl": "text",
    "channel": "text",
    "userName": "text"
  }
]

Remove a slack setting

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

slackSettingIdstringRequired

The Id of the slack setting

Responses

204

No Content

No content

403

Invalid credentials

404

Invalid slackSettingId

500

Internal Server Error

application/json

delete/v3/slackSetting/{slackSettingId}

HTTPcURLJavaScriptPython

DELETE /v3/slackSetting/{slackSettingId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content