Webhooks aboneliklerinin listesini al

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Yetkilendirme

api-token + language + role

Sorgu parametreleri

branch_idinteger

Örnek: 8412

Yanıtlar

object

statusstringzorunlu

Değerler:successerror

Örnek: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Örnek: 8920

typestringzorunlu

Örnek: select

optionarray of object

valueintegerzorunlu

Örnek: 8920

namestringzorunlu

Örnek: Green Basket | Kaliningrad

modestring (FilterMode)

Arayüzün filtreyi nasıl işlediği; standart bir filtrede mode yoktur. force_shown — her zaman gösterilir, gizlenemez. value_required — bölüme giriş noktasıdır: her zaman gösterilir, boş değeri yoktur (değer seçilene kadar liste boştur; "tümü" seçeneği yoktur), genel sıfırlama bunu temizlemez.

Değerler:force_shownvalue_required

Örnek: value_required

settingsobject (WebhooksBranchSettings)

secretstringnull olabilir

null, ağ henüz bir secret oluşturmadıysa

Örnek: 9f2c…

enabledbooleanzorunlu

Örnek: true

listarray of object

idintegerzorunlu

Örnek: 12

date_creationstring (DataTimeFormatSQL) zorunlu

Örnek: 2024-05-02 08:31:16

webhook_event_idintegerzorunlu

Örnek: 4

slugstringzorunlu

Webhook gövdesinde iletilen olay kodu

Örnek: order.created

translation_keystringzorunlu

Olay adının çeviri anahtarı

Örnek: webhooksSubscriptionsEvent.orderCreated

urlstringzorunlu

Örnek: https://partner.example.com/hooks/foodsoul

descriptionstringzorunlu

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

enabledbooleanzorunlu

Örnek: true

blockedbooleanzorunlu

Abonelik, bir dizi hatadan sonra otomatik olarak devre dışı bırakıldı

Örnek: false

count_errorsintegerzorunlu

Arka arkaya başarısız gönderim sayısı

Örnek: 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' => 'tr', '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": "tr", "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": "tr", "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 } ] } }