channelHooks.receiveChannelEvent

POST

/v1/hooks/channels/{channelId}

const url = 'https://example.com/v1/hooks/channels/example';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '"example"'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

application/json

Example ^generated

example

Responses

200

Success

application/json

Example ^generated

example

401

ChannelHookDenied

application/json

object

_tag

required

string

Allowed values: ChannelHookDenied

Example

{
  "_tag": "ChannelHookDenied"
}

503

ChannelsUnavailable | RequestFailed

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: ChannelsUnavailable

Example

{
  "_tag": "ChannelsUnavailable"
}

channelHooks.receiveChannelEvent

Parameters

Path Parameters

Request Bodyrequired

Example generated

Responses

200

Example generated

401

Example

503

Example

Request Body^required

Example ^generated

Example ^generated