crm-automation-trigger.md

Активировать триггер crm.automation.trigger

Scope: crm

Кто может выполнять метод: пользователь с доступом на изменение целевого объекта target

Активирует триггер Webhook, настроенный в автоматизации CRM.

Параметры метода

{% include Сноска об обязательных параметрах %}

#| || Название тип | Описание || || target* string | Целевой объект для автоматизации, указывается в виде TYPENAME_ID (например, LEAD_25) || || code string | Уникальный символьный код триггера, настроенного в Автоматизации на конкретный статус/стадию документа. Взять параметр code можно из настроек триггера || |#

{% note info %}

В редких случаях для указанного в target объекта может быть обнаружено несколько триггеров. Так происходит, если:

• не передать в запрос code и на портале есть старые триггеры, которым не выдан code
• передать code, который окажется одинаковым для нескольких триггеров В таком случае сработает первый триггер, который устанавливает более ранний статус объекта CRM

Также стоит учитывать, что у триггеров есть «Условия» и опция «Разрешить переходить на предыдущий статус», которые влияют на то, отработает триггер или нет.

{% endnote %}

Примеры кода

{% include Сноска о примерах %}

{% list tabs %}

• cURL (Webhook)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"target":"DEAL_57","code":"c5u4m"}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automation.trigger

• cURL (OAuth)

  curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"target":"DEAL_57","code":"c5u4m","auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/crm.automation.trigger

• JS

  BX24.callMethod(
      "crm.automation.trigger",
      {
          target: 'DEAL_57',
          code: 'c5u4m',
      },
      function(result) 
      {
          if(result.error())
              console.error(result.error());
          else
              console.dir(result.data());
      }
  );

• PHP

  require_once('crest.php');
  
  $result = CRest::call(
      'crm.automation.trigger',
      [
          'target' => 'DEAL_57',
          'code' => 'c5u4m'
      ]
  );
  
  echo '<PRE>';
  print_r($result);
  echo '</PRE>';

{% endlist %}

Обработка ответа

HTTP-статус: 200

{
    "result": true,
    "time": {
        "start":1718809827.810153,
        "finish":1718809828.541046,
        "duration":0.7308928966522217,
        "processing":0.09834408760070801,
        "date_start":"2024-06-19T15:10:27+00:00",
        "date_finish":"2024-06-19T15:10:28+00:00"
    }
}

Возвращаемые данные

#| || Название тип | Описание || || result boolean | Результат активации триггера || || time time | Информация о времени выполнения запроса || |#

Обработка ошибок

HTTP-статус: 400

{
    "error":"",
    "error_description":"Target is not set."
}

{% include notitle обработка ошибок %}

Возможные коды ошибок

#| || Код | Cообщение об ошибке | Описание || || Пустая строка | Target is not set. | Не передали обязательный параметр target || || Пустая строка | Incorrect target format. | Параметр target передан не в том формате, который нужен (Необходимый формат TYPENAME_ID) || || Пустая строка | Target is not found. | В параметр target передали неправильный TYPENAME || || ACCESS_DENIED | Access denied! There is no permissions to update the entity. | Пользователь, не прошёл проверку прав запуска триггера. || || Пустая строка | Access denied. | Пользователь не прошёл предварительную проверку прав на доступ к CRM || |#

{% include системные ошибки %}

Продолжите изучение

• {#T}
• {#T}