Получить справочники для формы подписки на вебхук

GET/api/crm/v2/webhooks_subscriptions.fieldsv2

operationId: webhooksSubscriptions.fields

Авторизация

api-token + language + role

Ответы

object

statusstringобязательный

Значения:successerror

Пример: success

dataobject

webhook_event_idobject (FilterSelect)

valuestring

Пример: example

typestringобязательный

Пример: select

optionarray of object

valuestringобязательный

Пример: example

namestringобязательный

Пример: All

modestring (FilterMode)

Как интерфейс обрабатывает фильтр; у обычного фильтра mode нет. force_shown — всегда показан, скрыть нельзя. value_required — точка входа в раздел: всегда показан, не имеет пустого значения (пока значение не выбрано, список пуст; варианта «все» нет), общий сброс его не очищает.

Значения:force_shownvalue_required

Пример: value_required

curl -X GET 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.fields' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: ru' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.fields', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'ru',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.fields", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ru",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.fields",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "ru",
        "role": "partner",
    },
)
data = response.json()

Ответ 200

{
  "status": "success",
  "data": {
    "webhook_event_id": {
      "value": "example",
      "type": "select",
      "option": [
        {
          "value": "example",
          "name": "All"
        }
      ],
      "mode": "value_required"
    }
  }
}

Запросы уходят на foodsoul.pro — хост этого портала, другой выбрать нельзя.