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

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Как использовать метод SDK bizproc.workflow.start в Битрикс24». Вы узнаете экспертные методики работы с bizproc.workflow.start и научитесь избегать типичных ошибок начинающих разработчиков.

Описание метода SDK bizproc.workflow.start

Метод bizproc.workflow.start является частью официального Bitrix24 PHP SDK и предназначен для выполнения REST-запросов к порталу. Launches a workflow

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

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

public function start(
      Workflows\Common\DocumentType $workflowDocumentType,
      int                           $bizProcTemplateId,
      int                           $entityId,
      array                         $callParameters = [],
      int                           $smartProcessId = null
  ): Result

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

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

<?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.workflow.start
    $workflowDocumentType = new \Workflows\Common\DocumentType();
    $bizProcTemplateId = 123;
    $entityId = 123;
    $callParameters = [];
    $smartProcessId = 123;

    // Выполнение запроса через Scope getBizProcScope и сервис workflow
    $result = $serviceBuilder->getBizProcScope()->workflow()->start(
          $workflowDocumentType,
          $bizProcTemplateId,
          $entityId,
          $callParameters,
          $smartProcessId
      );

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

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

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

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