Для разработчиков

Новый бот

POST/bots
bots:write

Создаёт бота в пространстве. По умолчанию бот получает входящий вебхук в своём формате и сразу отдаёт свой access_token. Сохраните токен при создании: тот же самый повторно не показывают, останется перевыпустить его методом POSTРотация токена бота.

С empty: true создаётся пустой бот, как в интерфейсе: только имя и ник, без токена и без входящего вебхука. Токены ему выпускают методом POSTНовый токен бота, а входящий вебхук включают полем kind в объекте webhook.

Созданный бот ещё никуда не пишет. В беседу и канал он пишет только как участник, а добавляют его как сотрудника — методом POSTДобавление участников, передав id бота. В канале бот получает роль редактора. Личные сообщения и треды в открытых чатах членства не требуют.

Входящий вебхук бота отправляет сообщение сразу во все беседы и каналы, где бот состоит, поэтому набор его чатов и решает, куда оно попадёт. Токен для этого не нужен, достаточно адреса вебхука. Чтобы написать в один конкретный чат, берите метод POSTНовое сообщение — вот там токен уже нужен.

Авторизацию от имени сотрудника можно включить сразу, передав oauth_client, а страницу в витрине заполнить в promo. У серверного клиента секрет приходит в client_secret один раз. Подробнее — в разделе Настройка авторизации. Ссылку авторизации для кнопки собирает и код на токен обменивает сервер бота — по шагам в разделе Получение токена.

Ник обязан заканчиваться на _bot и быть свободным в пространстве. Бота с разворачиванием ссылок создаёт только администратор или владелец пространства: остальным — 400 с кодом forbidden.

Аватар боту ставят после создания методом PUTЗагрузка аватара бота.

Тело запроса

application/json
empty
boolean
Создать пустого бота: без токена и без входящего вебхука. Без этого поля бот создаётся с входящим вебхуком в своём формате, а его токен приходит в access_token.
Пример:false
По умолчанию:
false
webhook
object
*
Объект параметров вебхука создаваемого бота
name
string
*
Имя бота
Пример:Бот задач
Длина:
<= 255 символов
nickname
string
Никнейм бота. Должен заканчиваться на _bot.
Пример:tasks_bot
Длина:
<= 255 символов
outgoing_url
string
URL исходящего вебхука
Пример:https://example.com/tasks/new
events[]
array of strings
События, на которые подписан бот
Возможные значения
Пример:["message_new"]
trigger_on
string
Условие срабатывания исходящего вебхука
Возможные значения
Пример:commands
По умолчанию:
commands
commands[]
array of strings
Команды бота (триггер-слова), на которые он реагирует при trigger_on = commands. Суммарная длина команд, объединённых через запятую, не должна превышать 255 символов.
Пример:["/task","/help"]
scopes[]
array of strings
Скоупы (права доступа) токена бота. Если не указано, бот получает набор по умолчанию. Боту доступны не все скоупы: часть из них разрешена только пользовательским ролям, и попытка назначить такой скоуп возвращает 400. Служебные значения bot и all назначать нельзя.
Пример:["messages:create"]
template
string
Шаблон форматирования входящего вебхука
Пример:Заказ от {{ client }} на сумму {{ amount }} ₽
template_engine
string
Шаблонизатор для обработки шаблона входящего вебхука. Без этого поля бот получает liquid, а пустой бот (empty: true) — mustache.
Возможные значения
Пример:liquid
challenge_key
string
Название поля проверки для верификации входящего вебхука
Пример:challenge
ignore_self_messages
boolean
Не присылать боту события о его собственных сообщениях и реакциях
Пример:false
По умолчанию:
false
events_history_enabled
boolean
Сохранять историю событий бота для последующего получения через метод истории событий
Пример:false
По умолчанию:
false
who_can_add
string
Кто может добавлять бота в чаты
Возможные значения
Пример:creator
По умолчанию:
creator
can_edit[]
array of strings
Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:["admin"]
single_chat
boolean
Ограничивает бота одной беседой или каналом: true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.
Пример:false
По умолчанию:
false
kind
string
Источник входящего вебхука. Без empty по умолчанию simple, а у пустого бота входящий вебхук включается только этим полем.
Возможные значения
Пример:simple
unfurl_domains[]
array of strings
Домены, ссылки на которые бот разворачивает, не больше 5. Работают вместе с событием message_link_shared.
Пример:["example.com"]
Количество:
<= 5 элементов
oauth_client
object
Включить авторизацию от имени сотрудника сразу при создании
confidential
boolean
Где хранится секрет: true — серверное приложение хранит client_secret и обменивает код у себя, false — приложение без секрета (браузер, мобильное, CLI) обменивает код по PKCE. Если не передать, значение не меняется, а у нового клиента — true.
Пример:true
redirect_uris[]
array of strings
Адреса возврата после согласия. Веб-адресу нужен HTTPS: простой http допустим только для localhost, 127.0.0.1 и [::1]. Подходит и своя схема приложения вида com.example.app:/oauth. Фрагмент #… в адресе недопустим. Адрес в ссылке авторизации должен совпадать с одним из списка. Параметры запроса при этом сверяются, только если они есть у адреса в списке, а у адресов на этом же компьютере не сравнивается порт. Подробнее — в разделе Включение. При включении передайте хотя бы один адрес. Список заменяется целиком.
Пример:["https://example.com/oauth/callback"]
scopes[]
array of strings
Права, которые бот запрашивает у сотрудника на экране согласия. Доступны только права, которые можно выдать самому боту. Если при включении поле не передать, запрашиваются все права бота. Список заменяется целиком.
Пример:["messages:read","messages:create"]
promo
object
Страница бота в витрине. Задаётся только вместе с oauth_client: без авторизации страницы у бота нет.
description
string
Описание: чем бот занимается и зачем его подключать. Без описания бота нельзя опубликовать.
Пример:Собирает сводку по задачам Jira и присылает её в чат
published
boolean
Опубликовать бота в витрине: он появится карточкой на вкладке «Обзор». Публикация требует описания.
Пример:true
promo_images[]
array of strings
Скриншоты страницы бота, не больше 5: ключи загруженных изображений (key из POSTПолучение подписи, ключа и других параметров). Список заменяется целиком, порядок сохраняется.
Пример:["attaches/files/93746/e354fd79-4f3e-4b5a-9c8d-1a2b3c4d5e6f/screenshot.png"]
Количество:
<= 5 элементов

Ответ

201Created
The request has succeeded and a new resource has been created as a result.
data
object
*
Параметры созданного бота
id
integer, (int32)
*
Идентификатор бота (совпадает с user_id бота)
Пример:1738816
name
string
*
Имя бота
Пример:Бот задач
nickname
string
*
Никнейм бота
Пример:tasks_bot
avatar_url
nullablestring
*
Ссылка на аватар бота. null, если аватар не задан.
Пример:https://files.example.com/uploads/0001/0001/image.jpg
creator_id
nullableinteger, (int32)
*
Идентификатор сотрудника, создавшего бота. null, если создатель не записан.
Пример:12
created_at
string, (date-time)
*
Дата и время создания бота (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ
Пример:2025-05-15T14:30:00.000Z
authorized_users_count
integer, (int32)
*
Сколько сотрудников авторизовали бота
Пример:3
last_used_at
nullablestring, (date-time)
*
Дата и время, когда бот последний раз работал (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ: запрос на входящий вебхук или вызов API любым токеном бота, включая токены сотрудников. null, если такого не было. Использование токена учитывается не чаще раза в минуту.
Пример:2025-05-15T14:30:00.000Z
webhook
object
*
Объект параметров вебхука
name
string
*
Имя бота
Пример:Бот задач
Длина:
<= 255 символов
nickname
string
*
Никнейм бота
Пример:tasks_bot
Длина:
<= 255 символов
outgoing_url
nullablestring
*
URL исходящего вебхука. null, если исходящий вебхук у бота не настроен.
Пример:https://example.com/tasks/new
events[]
array of strings
*
События, на которые подписан бот
Возможные значения
Пример:["message_new"]
trigger_on
string
*
Условие срабатывания исходящего вебхука
Возможные значения
Пример:commands
commands[]
array of strings
*
Команды бота (триггер-слова)
Пример:["/task"]
scopes[]
array of strings
*
Скоупы (права доступа) токена бота. Набор по умолчанию шире того, что можно назначить явно, поэтому здесь могут встречаться значения, недоступные для явной установки.
Пример:["messages:create"]
template
nullablestring
*
Шаблон форматирования входящего вебхука. null, если не задан.
Пример:Заказ от {{ client }} на сумму {{ amount }} ₽
template_engine
string
*
Шаблонизатор для обработки шаблона входящего вебхука
Возможные значения
Пример:liquid
challenge_key
nullablestring
*
Название поля проверки для верификации входящего вебхука. null, если не задано.
Пример:challenge
ignore_self_messages
boolean
*
Не присылать боту события о его собственных сообщениях и реакциях
Пример:false
events_history_enabled
boolean
*
Сохранять историю событий бота для последующего получения через метод истории событий
Пример:false
single_chat
boolean
*
Ограничивает бота одной беседой или каналом: true — бота можно добавить только в один такой чат, false — в несколько. Личные чаты и треды в ограничение не входят.
Пример:false
can_edit[]
array of strings
*
Роли, которым, помимо создателя, разрешено редактировать настройки бота. Создатель может редактировать всегда. Пустой массив — редактировать может только создатель.
Возможные значения
Пример:["admin"]
who_can_add
string
*
Кто может добавлять бота в чаты
Возможные значения
Пример:creator
kind
nullablestring
*
Источник входящего вебхука. null, если входящий вебхук у бота выключен.
Возможные значения
Пример:simple
unfurl_domains[]
array of strings
*
Домены, ссылки на которые бот разворачивает
Пример:["example.com"]
last_request_at
nullablestring, (date-time)
*
Дата и время последнего запроса на входящий вебхук бота (ISO-8601, UTC+0) в формате YYYY-MM-DDThh:mm:ss.sssZ. null, если запросов не было.
Пример:2025-05-15T14:30:00.000Z
url
nullablestring
Адрес входящего вебхука. null, если входящий вебхук у бота выключен. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).
Пример:https://api.pachca.com/webhooks/01JAXK7R3B5Y8Q2W4E6T9V1N3M
secret_token
string
Секрет подписи исходящего вебхука: им подписан заголовок Pachca-Signature. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).
Пример:pachca_wh_3pX9vQ2mL7rT5yW8kN4bH6jF1dS0aZcVxE2uI9oP7qR3tY5wK8nM4gB6hJ1lD0fA
last_request_body
nullablestring
Тело последнего запроса на входящий вебхук бота. Длиннее 128 КБ обрезается и заканчивается на ...[truncated]. null, если запросов не было. Приходит в ответе об одном боте токену со скоупом bots:write, который может управлять токенами бота (permissions.recreate_token).
Пример:{"client": "ООО Ромашка", "amount": 15000}
oauth_client_enabled
boolean
*
Включена ли у бота авторизация от имени сотрудника
Пример:true
oauth_client
nullableobject
*
Параметры авторизации от имени сотрудника. Может прийти и у бота с выключенной авторизацией, поэтому включена ли она, смотрите в oauth_client_enabled. У бота без токенов может прийти null.
client_id
string
*
Идентификатор клиента для ссылки авторизации
Пример:aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xY
client_secret_preview
string
*
Секрет клиента в маскированном виде. Полное значение приходит в client_secret один раз: при включении серверного клиента и при ротации секрета.
Пример:cH5kR9mN...x7Qp
confidential
boolean
*
Где хранится секрет: true — серверное приложение, false — приложение без секрета, обмен кода по PKCE
Пример:true
redirect_uris[]
array of strings
*
Адреса возврата после согласия
Пример:["https://example.com/oauth/callback"]
scopes[]
array of strings
*
Права, которые бот запрашивает у сотрудника на экране согласия
Пример:["messages:read","messages:create"]
promo
nullableobject
*
Страница бота в витрине. null, если авторизация у бота выключена.
description
nullablestring
*
Описание бота. null, если не задано.
Пример:Собирает сводку по задачам Jira и присылает её в чат
published
boolean
*
Опубликован ли бот в витрине
Пример:true
promo_images[]
array of objects
*
Скриншоты страницы бота
key
string
*
Ключ изображения
Пример:attaches/files/93746/e354fd79-4f3e-4b5a-9c8d-1a2b3c4d5e6f/screenshot.png
url
string
*
Ссылка на изображение
Пример:https://files.example.com/attaches/files/93746/e354fd79-4f3e-4b5a-9c8d-1a2b3c4d5e6f/screenshot.png
permissions
object
*
Что вы можете делать с этим ботом
update_oauth_client
boolean
*
Менять авторизацию от имени сотрудника, страницу в витрине и имя бота
Пример:true
recreate_token
boolean
*
Выпускать, менять и удалять токены бота и обновлять секрет клиента
Пример:true
destroy
boolean
*
Удалить бота
Пример:true
client_secret
string
Секрет клиента. Приходит один раз: при включении серверного клиента, при переходе на него и при ротации секрета.
Пример:dGhpc19pc19ub3RfYV9yZWFsX3NlY3JldA
access_token
string
Токен доступа бота. Возвращается при создании бота и при ротации токена. Не приходит, если бот создан с empty: true.
Пример:bm90X2FfcmVhbF90b2tlbg
Новый бот
pachca bots create \  --name='Бот задач' \  --nickname=tasks_bot \  --outgoing-url=https://example.com/tasks/new \  --events='["message_new"]' \  --commands='["/task","/help"]' \  --scopes='["messages:create"]' \  --template='Заказ от {{ client }} на сумму {{ amount }} ₽' \  --template-engine=liquid \  --challenge-key=challenge \  --can-edit='["admin"]' \  --kind=simple \  --unfurl-domains='["example.com"]' \  --oauth-client='{"confidential":true,"redirect_uris":["https://example.com/oauth/callback"],"scopes":["messages:read","messages:create"]}' \  --promo='{"description":"Собирает сводку по задачам Jira и присылает её в чат","published":true,"promo_images":["attaches/files/93746/e354fd79-4f3e-4b5a-9c8d-1a2b3c4d5e6f/screenshot.png"]}' \  --json \  --token YOUR_ACCESS_TOKEN
Ответ 201
{  "data": {    "id": 1738816,    "name": "Бот задач",    "nickname": "tasks_bot",    "avatar_url": null,    "creator_id": 12,    "created_at": "2025-05-15T14:30:00.000Z",    "authorized_users_count": 0,    "last_used_at": null,    "webhook": {      "name": "Бот задач",      "nickname": "tasks_bot",      "outgoing_url": "https://example.com/tasks/new",      "events": [        "message_new"      ],      "trigger_on": "commands",      "commands": [        "/task"      ],      "scopes": [        "messages:create"      ],      "template": "Заказ от {{ client }} на сумму {{ amount }} ₽",      "template_engine": "liquid",      "challenge_key": "challenge",      "link_preview_enabled": true,      "ignore_self_messages": false,      "events_history_enabled": false,      "single_chat": false,      "can_edit": [        "admin"      ],      "who_can_add": "creator",      "kind": "simple",      "unfurl_domains": [],      "last_request_at": null,      "url": "https://api.pachca.com/webhooks/01JAXK7R3B5Y8Q2W4E6T9V1N3M",      "secret_token": "pachca_wh_3pX9vQ2mL7rT5yW8kN4bH6jF1dS0aZcVxE2uI9oP7qR3tY5wK8nM4gB6hJ1lD0fA",      "last_request_body": null    },    "oauth_client_enabled": true,    "oauth_client": {      "client_id": "aB3dE5fG7hJ9kL1mN3pQ5rS7tU9vW1xY",      "client_secret_preview": "dGhpc19p...ZWNy",      "confidential": true,      "redirect_uris": [        "https://example.com/oauth/callback"      ],      "scopes": [        "messages:read",        "messages:create"      ]    },    "promo": {      "description": null,      "published": false,      "promo_images": []    },    "permissions": {      "update_oauth_client": true,      "recreate_token": true,      "destroy": true    },    "client_secret": "dGhpc19pc19ub3RfYV9yZWFsX3NlY3JldA",    "access_token": "bm90X2FfcmVhbF90b2tlbg"  }}