Получить список подписок на вебхуки

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 8412

Ответы

object

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

Значения:successerror

Пример: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Пример: 8920

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

Пример: select

optionarray of object

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

Пример: 8920

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

Пример: Green Basket | Kaliningrad

modestring (FilterMode)

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

Значения:force_shownvalue_required

Пример: value_required

settingsobject (WebhooksBranchSettings)

secretstringможет быть null

null, пока сеть не создала секрет

Пример: 9f2c…

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

Пример: true

listarray of object

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

Пример: 12

date_creationstring (DataTimeFormatSQL) обязательный

Пример: 2024-05-02 08:31:16

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

Пример: 4

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

Код события, который передаётся в теле вебхука

Пример: order.created

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

Ключ перевода названия события

Пример: webhooksSubscriptionsEvent.orderCreated

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

Пример: https://partner.example.com/hooks/foodsoul

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

Пример: Учётная система

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

Пример: true

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

Подписка автоматически отключена после серии ошибок

Пример: false

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

Число неудачных отправок подряд

Пример: 0

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/webhooks_subscriptions', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/webhooks_subscriptions", { 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.ru/api/crm/v2/webhooks_subscriptions", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "settings": { "secret": "9f2c…", "enabled": true }, "list": [ { "id": 12, "date_creation": "2024-05-02 08:31:16", "webhook_event_id": 4, "slug": "order.created", "translation_key": "webhooksSubscriptionsEvent.orderCreated", "url": "https://partner.example.com/hooks/foodsoul", "description": "Учётная система", "enabled": true, "blocked": false, "count_errors": 0 } ] } }