Как использовать метод SDK bizproc.robot.update в Битрикс24

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать метод SDK bizproc.robot.update в Битрикс24», проанализируем лучшие практики и покажем, как правильно использовать bizproc.robot.update в реальных задачах.

Описание метода SDK bizproc.robot.update

Метод bizproc.robot.update является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. updates fields of automation rules

Параметры и сигнатура метода

В рамках SDK метод объявлен в пространстве имен \Bitrix24\SDK\Services\Workflows\Robot\Service\Robot со следующей сигнатурой:

public function update(
      string  $code,
      ?string $handlerUrl = null,
      ?int    $b24AuthUserId = null,
      ?array  $localizedRobotName = null,
      ?bool   $isUseSubscription = null,
      ?array  $properties = null,
      ?bool   $isUsePlacement = null,
      ?array  $returnProperties = null
  ): Result

Пример использования на PHP

Ниже представлен готовый практический пример интеграции с использованием Bitrix24 PHP SDK. Этот пример показывает, как правильно инициализировать сервис-билдер и вызвать метод update:

<?php
declare(strict_types=1);

use Bitrix24\SDK\Services\ServiceBuilderFactory;

// Инициализация официального Bitrix24 PHP SDK через входящий вебхук
$webhookUrl = 'https://your-portal.bitrix24.ru/rest/1/your-webhook-code/';
$serviceBuilder = ServiceBuilderFactory::createServiceBuilderFromWebhook($webhookUrl);

try {
    // Подготовка параметров для вызова метода bizproc.robot.update
    $code = "пример_значения";
    $handlerUrl = null;
    $b24AuthUserId = null;
    $localizedRobotName = null;
    $isUseSubscription = null;
    $properties = null;
    $isUsePlacement = null;
    $returnProperties = null;

    // Выполнение запроса через Scope getBizProcScope и сервис robot
    $result = $serviceBuilder->getBizProcScope()->robot()->update(
          $code,
          $handlerUrl,
          $b24AuthUserId,
          $localizedRobotName,
          $isUseSubscription,
          $properties,
          $isUsePlacement,
          $returnProperties
      );

    // Обработка полученных данных
    print_r($result->getResponseData()->getResult());

} catch (\Throwable $exception) {
    // Обработка исключений при интеграции
    echo "Ошибка при выполнении метода bizproc.robot.update: " . $exception->getMessage();
}

Полезные ссылки

• Официальная REST API документация: https://training.bitrix24.com/rest_help/workflows/app_automation_rules/bizproc_robot_update.php
• Репозиторий PHP SDK на GitHub: bitrix24-php-sdk