Webhook abunəliklərinin siyahısını əldə et

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Avtorizasiya

api-token + language + role

Sorğu parametrləri

branch_idinteger

Nümunə: 8412

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

settingsobject (WebhooksBranchSettings)

secretstringnull ola bilər

null, şəbəkə hələ secret yaratmayıb

Nümunə: 9f2c…

enabledbooleanmütləq

Nümunə: true

listarray of object

idintegermütləq

Nümunə: 12

date_creationstring (DataTimeFormatSQL) mütləq

Nümunə: 2024-05-02 08:31:16

webhook_event_idintegermütləq

Nümunə: 4

slugstringmütləq

Hadisə kodu, webhook-un gövdəsində ötürülür

Nümunə: order.created

translation_keystringmütləq

Hadisənin adının tərcümə açarı

Nümunə: webhooksSubscriptionsEvent.orderCreated

urlstringmütləq

Nümunə: https://partner.example.com/hooks/foodsoul

descriptionstringmütləq

Nümunə: Учётная система

enabledbooleanmütləq

Nümunə: true

blockedbooleanmütləq

Abunə bir sıra xətalardan sonra avtomatik olaraq deaktiv edilir

Nümunə: false

count_errorsintegermütləq

Ardıcıl uğursuz göndərişlərin sayı

Nümunə: 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' => 'az', '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": "az", "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": "az", "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 } ] } }