К тексту на этой странице мог быть частично применён машинный перевод.

Справочник по входящим вебхукам

Доступно для:

Планы:

  • Bridge by Smartsheet

Запрос рабочего процесса

С помощью URL-адреса запроса вебхука вы можете сделать запрос POST для запуска рабочего процесса Bridge. Вы можете использовать следующее тело запроса:

{

"workflow":"имя рабочего процесса или UUID",

"stateValues":{

"statename":"value"

},

"uid":"сгенерированный уникальный идентификатор для запроса",

"extra_stuff":{

"много":"из этого"

}

}

  • workflow: Единственное обязательное поле, которое должно быть задано в качестве допустимого имени рабочего процесса или значения UUID.
  • stateValues: необязательное поле, используемое для предварительной настройки состояний рабочего процесса с указанным значением.
  • uid: уникальный идентификатор (uid), используемый для того, чтобы наша система игнорировала повторяющиеся запросы, если вы отправляете один и тот же запрос несколько раз.
  • Все остальные поля, которые вы отправляете как часть тела POST: 
    • Передается в рабочий процесс, и на него ссылаются с помощью рулок времени выполнения, например {{runtime.extra_stuff.lots}}, с возвратом
    • Будет передано любое допустимое значение JSON

Помните, что все запросы к этой конечной точке требуют, чтобы заголовок Inbound-Webhook-Secret был установлен со значениями Secret .

 

Это решение не поддерживает веб-перехватчики, которые включают запрос на проверку. Для этого необходимо создать новую пользовательскую интеграцию.


Пакетные запросы рабочих процессов

Если вы хотите запустить более одного рабочего процесса с одним запросом, вы можете передать объект пакета как часть запроса тела:

{

"workflow":"имя рабочего процесса или UUID",

"batch":[

{

"uid": "запрос1",

"workflow":"альтернативный workflow",

"stateValues":{

"state":"value"

},

"runtimeData":{

Key/Value (Ключ/Значение)

}

},

{

"uid": "запрос2",

"stateValues":{

"state":"value"

}

}

]

}

Примечания

  • Объект пакетного запроса использует те же поля, что и основной запрос, с добавлением runtimeData, который используется для установки данных, доступных для ручки {{runtime}} в рабочем процессе.

  • Если в объекте пакетного запроса не указаны значения рабочего процесса или состояния, вместо них используются значения, заданные в родительском объекте. В приведенном выше примере два рабочих процесса будут выполнять request1 с альтернативным рабочим процессом, а request2 — с начальным рабочим процессом.
  • Если вы хотите переопределить родительские значения ничем, установите пустой объект для stateValues. Неопределенные значения считаются не установленными, и будет использоваться родительское значение. Поле uid из родительского объекта игнорируется при использовании пакетных запросов, но каждый объект пакетной обработки может задать свой собственный uid, если это необходимо.
  • Даже если каждый объект пакета определяет свой собственный рабочий процесс, рабочий процесс в основном запросе все равно является обязательным.