Ստանալ վեբհուքերի բաժանորդագրությունների ցանկը

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