Вебхуктарға жазылулар тізімін алу

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)

secretstringnull мәнін қабылдай алады

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' => 'kk', '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": "kk", "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": "kk", "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 } ] } }