Obține lista abonamentelor la webhook-uri

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorizare

api-token + language + role

Parametri de interogare

branch_idinteger

Exemplu: 8412

Răspunsuri

object

statusstringobligatoriu

Valori:successerror

Exemplu: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemplu: 8920

typestringobligatoriu

Exemplu: select

optionarray of object

valueintegerobligatoriu

Exemplu: 8920

namestringobligatoriu

Exemplu: Green Basket | Kaliningrad

modestring (FilterMode)

Cum interfața procesează filtrul; filtrul obișnuit nu are mode. force_shown — este întotdeauna afișat, nu poate fi ascuns. value_required — punct de intrare în secțiune: este întotdeauna afișat, nu poate avea valoare goală (până când nu este selectată o valoare, lista este goală; nu există opțiunea „toate”), resetarea generală nu îl curăță.

Valori:force_shownvalue_required

Exemplu: value_required

settingsobject (WebhooksBranchSettings)

secretstringpoate fi null

null, până când rețeaua nu a creat secretul

Exemplu: 9f2c…

enabledbooleanobligatoriu

Exemplu: true

listarray of object

idintegerobligatoriu

Exemplu: 12

date_creationstring (DataTimeFormatSQL) obligatoriu

Exemplu: 2024-05-02 08:31:16

webhook_event_idintegerobligatoriu

Exemplu: 4

slugstringobligatoriu

Codul evenimentului transmis în corpul webhook-ului

Exemplu: order.created

translation_keystringobligatoriu

Cheia de traducere a denumirii evenimentului

Exemplu: webhooksSubscriptionsEvent.orderCreated

urlstringobligatoriu

Exemplu: https://partner.example.com/hooks/foodsoul

descriptionstringobligatoriu

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

enabledbooleanobligatoriu

Exemplu: true

blockedbooleanobligatoriu

Abonamentul este dezactivat automat după o serie de erori

Exemplu: false

count_errorsintegerobligatoriu

Numărul de livrări eșuate consecutiv

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