Pobierz listę subskrypcji webhooków

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 8412

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

settingsobject (WebhooksBranchSettings)

secretstringmoże być null

null, dopóki sieć nie utworzyła sekretu

Przykład: 9f2c…

enabledbooleanwymagane

Przykład: true

listarray of object

idintegerwymagane

Przykład: 12

date_creationstring (DataTimeFormatSQL) wymagane

Przykład: 2024-05-02 08:31:16

webhook_event_idintegerwymagane

Przykład: 4

slugstringwymagane

Kod zdarzenia przesyłany w treści webhooka

Przykład: order.created

translation_keystringwymagane

Klucz tłumaczenia nazwy zdarzenia

Przykład: webhooksSubscriptionsEvent.orderCreated

urlstringwymagane

Przykład: https://partner.example.com/hooks/foodsoul

descriptionstringwymagane

Przykład: Учётная система

enabledbooleanwymagane

Przykład: true

blockedbooleanwymagane

Subskrypcja została automatycznie wyłączona po serii błędów

Przykład: false

count_errorsintegerwymagane

Liczba kolejnych nieudanych wysyłek

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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 } ] } }