channels.createChannel

POST

/v1/organization/channels

curl --request POST \
  --url https://example.com/v1/organization/channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandKey": "example", "name": "example", "bot": "example", "credentials": { "kind": "slack", "botToken": "example", "signingSecret": "example" }, "linkPath": "example", "enabled": true }'

Saves a Channel and starts its configuration execution. The caller becomes its actor. Read executionId to check registration.

Authorizations

• token
• session

Request Body^required

Media typeapplication/json

object

commandKey

required

string

>= 1 characters <= 128 characters

name

required

string

>= 1 characters <= 120 characters

bot

required

string

>= 1 characters <= 128 characters

credentials

required

Any of:

object

object

kind

required

string

Allowed values: slack

botToken

required

string

>= 1 characters <= 4096 characters

signingSecret

required

string

>= 1 characters <= 4096 characters

object

object

kind

required

string

Allowed values: lark

domain

required

string

Allowed values: feishu lark

appId

required

string

>= 1 characters <= 200 characters

appSecret

required

string

>= 1 characters <= 4096 characters

verificationToken

required

string

>= 1 characters <= 4096 characters

encryptKey

required

string

>= 1 characters <= 4096 characters

object

object

kind

required

string

Allowed values: telegram

botToken

required

string

>= 1 characters <= 4096 characters

object

object

kind

required

string

Allowed values: custom

endpoint

required

string

>= 1 characters <= 2048 characters

linkPath

string

<= 4096 characters

enabled

boolean

Responses

201

Success

Media typeapplication/json

object

id

required

string

>= 1 characters <= 128 characters

kind

required

string

Allowed values: slack lark telegram custom

name

required

string

bot

required

string

>= 1 characters <= 128 characters

actor

required

string

enabled

required

boolean

needsAuthorization

required

boolean

linkPath

required

Any of:

string

string

null

null

credentials

required

Any of:

object

object

kind

required

string

Allowed values: slack

botToken

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

signingSecret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: lark

domain

required

string

Allowed values: feishu lark

appId

required

string

appSecret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

verificationToken

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

encryptKey

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: telegram

botToken

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

object

object

kind

required

string

Allowed values: custom

endpoint

required

string

secret

required

object

set

required

boolean

hint

required

Any of:

string

string

null

null

executionId

required

Any of:

string

string

>= 1 characters <= 128 characters

null

null

version

required

integer

<= 9007199254740991

createdAt

required

number

updatedAt

required

number

webhookUrl

required

string

Example

{
  "kind": "slack",
  "credentials": {
    "kind": "slack"
  }
}

400

ChannelInvalid | OrganizationRequired

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ChannelInvalid

message

required

string

object

object

_tag

required

string

Allowed values: OrganizationRequired

Example

{
  "_tag": "ChannelInvalid"
}

401

AuthenticationRequired

Media typeapplication/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

ExecutionForbidden | @nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionForbidden

object

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

object

object

_tag

required

string

Allowed values: MembershipRequired

object

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ExecutionForbidden"
}

404

ExecutionNotFound | ChannelNotFound | ChannelIdentityNotFound

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionNotFound

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ChannelNotFound

id

required

string

object

object

_tag

required

string

Allowed values: ChannelIdentityNotFound

Example

{
  "_tag": "ExecutionNotFound"
}

409

ExecutionConflict | ExecutionKeyConflict | @nmnmcc/ability/Authorizer/Pending | ChannelConflict

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionConflict

id

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: ExecutionKeyConflict

object

object

_tag

required

string

Allowed values: Pending

ticket

required

string

reason

string

object

object

_tag

required

string

Allowed values: ChannelConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "ExecutionConflict"
}

429

RateLimited

Media typeapplication/json

object

_tag

required

string

Allowed values: RateLimited

retryAfterSeconds

required

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "_tag": "RateLimited"
}

503

ExecutionUnavailable | ChannelsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json

Any of:

object

object

_tag

required

string

Allowed values: ExecutionUnavailable

errorId

required

string

>= 1 characters <= 128 characters

object

object

_tag

required

string

Allowed values: PolicyUnavailable

object

object

_tag

required

string

Allowed values: ChannelsUnavailable

object

object

_tag

required

string

Allowed values: AuthenticationUnavailable

object

object

_tag

required

string

Allowed values: RequestFailed

category

required

string

Allowed values: invalid forbidden not_found conflict unavailable external outcome_unknown interrupted

errorId

required

string

>= 1 characters <= 128 characters

Example

{
  "_tag": "ExecutionUnavailable"
}