Získat seznam odběrů webhooků

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 8412

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

settingsobject (WebhooksBranchSettings)

secretstringmůže být null

null, dokud síť nevytvoří tajný klíč

Příklad: 9f2c…

enabledbooleanpovinné

Příklad: true

listarray of object

idintegerpovinné

Příklad: 12

date_creationstring (DataTimeFormatSQL) povinné

Příklad: 2024-05-02 08:31:16

webhook_event_idintegerpovinné

Příklad: 4

slugstringpovinné

Kód události, který je předáván v těle webhooku

Příklad: order.created

translation_keystringpovinné

Klíč překladu názvu události

Příklad: webhooksSubscriptionsEvent.orderCreated

urlstringpovinné

Příklad: https://partner.example.com/hooks/foodsoul

descriptionstringpovinné

Příklad: Учётная система

enabledbooleanpovinné

Příklad: true

blockedbooleanpovinné

Odběr je automaticky deaktivován po sérii chyb

Příklad: false

count_errorsintegerpovinné

Počet po sobě jdoucích neúspěšných odeslání

Příklad: 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' => 'cs', '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": "cs", "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": "cs", "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 } ] } }