channelHooks.receiveChannelEvent

POST

/v1/hooks/channels/{channelId}

curl --request POST \
  --url https://example.com/v1/hooks/channels/example \
  --header 'Content-Type: application/json' \
  --data '"example"'

Takes an event from Slack, Lark, Telegram or a custom Channel. OpenBot checks the signature, answers at once, and does the work later. A custom Channel sends a CustomEvent with X-OpenBot-Timestamp and X-OpenBot-Signature: sha256=<hex HMAC-SHA256 of timestamp + "." + body>.

Parameters

Path Parameters

channelId

required

string

>= 1 characters <= 128 characters

Request Body^required

Media typeapplication/json

Example ^generated

example

Responses

200

Success

Media typeapplication/json

Example ^generated

example

401

ChannelHookDenied

Media typeapplication/json

object

_tag

required

string

Allowed values: ChannelHookDenied

Example

{
  "_tag": "ChannelHookDenied"
}

503

ChannelsUnavailable

Media typeapplication/json

object

_tag

required

string

Allowed values: ChannelsUnavailable

Example

{
  "_tag": "ChannelsUnavailable"
}