Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

Краткие сведения

Page Properties

Типы запросов

Status
colourGreen
titlePOST
 

Описание

Выставление адреса webhook

Название

SetHook

URL

/v1/hook/

Описание

Метод

...

устанавливает webhook для получения событий.

Запрос к серверу

...

Параметры URL

...

Поле

Тип

Описание

...

...

ID объекта, на который осуществляется подписка:

  • ID линии поддержки

type

String

Тип подписки:

  • bot - на события для чат бота для указанной линии поддержки (обязателен id)

  • line - все события по линии(ям) поддержки

url

String

URL WebHook. На этот адрес будут прилетать все события POST-запросами.

id

UUID?

ID объекта, на который осуществляется подписка:

  • ID линии поддержки

Пример

Выставление адреса webhook для бота

Code Block
languagejs

...

...

POST /v1/hook/ HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0
Content-Type: application/json
Content-Length: 111

{ "id": "b7ae5029-b9a7-4e55-8179-37b05a5865ae", "type": "bot", "url": "https://push.example.com/connect/hook/"}

...

Curl

Code Block
languagejs

...

curl -X POST "https://push.1c-connect.com/v1/hook/" \
-H "accept: application/json" \
-H "authorization: Basic dGVzdDp0ZXN0" \
-H "Content-Type: application/json" \
-d "{ \"id\": \"b7ae5029-b9a7-4e55-8179-37b05a5865ae\", \"type\": \"bot\", \"url\": \"https://push.example.com/connect/hook/\"}"

Ответ сервера

Нет тела

Ошибки

Код

Описание

400

Запрос содержит ошибку

401

Пользователь не авторизован

403

Недостаточно прав