Отримати список підписок на вебхуки

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.pro/api/crm/v2/webhooks_subscriptions', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'uk', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/webhooks_subscriptions", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "uk", "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 } ] } }