Webhook obunalar ro‘yxatini olish

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Avtorizatsiya

api-token + language + role

So‘rov parametrlari

branch_idinteger

Misol: 8412

Javoblar

object

statusstringmajburiy

Qiymatlar:successerror

Misol: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Misol: 8920

typestringmajburiy

Misol: select

optionarray of object

valueintegermajburiy

Misol: 8920

namestringmajburiy

Misol: Green Basket | Kaliningrad

modestring (FilterMode)

Interfeys filtrni qanday ishlashini belgilaydi; oddiy filtrda mode mavjud emas. force_shown — doim ko‘rsatiladi, yashirib bo‘lmaydi. value_required — bo‘limga kirish nuqtasi: doim ko‘rsatiladi, bo‘sh qiymatga ega emas (qiymat tanlanmaguncha ro‘yxat bo‘sh; “barchasi” varianti yo‘q), umumiy tozalash uni tozalamaydi.

Qiymatlar:force_shownvalue_required

Misol: value_required

settingsobject (WebhooksBranchSettings)

secretstringnull bo‘lishi mumkin

null, tarmoq maxfiy so‘zni yaratmaguncha

Misol: 9f2c…

enabledbooleanmajburiy

Misol: true

listarray of object

idintegermajburiy

Misol: 12

date_creationstring (DataTimeFormatSQL) majburiy

Misol: 2024-05-02 08:31:16

webhook_event_idintegermajburiy

Misol: 4

slugstringmajburiy

Webhook tanasida uzatiladigan hodisa kodi

Misol: order.created

translation_keystringmajburiy

Tadbir nomining tarjima kaliti

Misol: webhooksSubscriptionsEvent.orderCreated

urlstringmajburiy

Misol: https://partner.example.com/hooks/foodsoul

descriptionstringmajburiy

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

enabledbooleanmajburiy

Misol: true

blockedbooleanmajburiy

Obuna bir qator xatolardan so‘ng avtomatik ravishda o‘chiriladi

Misol: false

count_errorsintegermajburiy

Ketma-ket muvaffaqiyatsiz yuborishlar soni

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