Λήψη λίστας συνδρομών σε webhooks

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Εξουσιοδότηση

api-token + language + role

Παράμετροι ερωτήματος

branch_idinteger

Παράδειγμα: 8412

Απαντήσεις

object

statusstringυποχρεωτικό

Τιμές:successerror

Παράδειγμα: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Παράδειγμα: 8920

typestringυποχρεωτικό

Παράδειγμα: select

optionarray of object

valueintegerυποχρεωτικό

Παράδειγμα: 8920

namestringυποχρεωτικό

Παράδειγμα: Green Basket | Kaliningrad

modestring (FilterMode)

Πώς το περιβάλλον χειρίζεται το φίλτρο· το συνηθισμένο φίλτρο δεν έχει mode. Το force_shown — εμφανίζεται πάντα, δεν μπορεί να αποκρυφθεί. Το value_required — σημείο εισόδου στην ενότητα: εμφανίζεται πάντα, δεν έχει κενή τιμή (μέχρι να επιλεγεί τιμή, η λίστα είναι κενή· δεν υπάρχει επιλογή «όλα»), η γενική επαναφορά δεν το καθαρίζει.

Τιμές:force_shownvalue_required

Παράδειγμα: value_required

settingsobject (WebhooksBranchSettings)

secretstringμπορεί να είναι null

null, μέχρι το δίκτυο να δημιουργήσει το secret

Παράδειγμα: 9f2c…

enabledbooleanυποχρεωτικό

Παράδειγμα: true

listarray of object

idintegerυποχρεωτικό

Παράδειγμα: 12

date_creationstring (DataTimeFormatSQL) υποχρεωτικό

Παράδειγμα: 2024-05-02 08:31:16

webhook_event_idintegerυποχρεωτικό

Παράδειγμα: 4

slugstringυποχρεωτικό

Ο κωδικός συμβάντος που αποστέλλεται στο σώμα του webhook

Παράδειγμα: order.created

translation_keystringυποχρεωτικό

Κλειδί μετάφρασης ονόματος συμβάντος

Παράδειγμα: webhooksSubscriptionsEvent.orderCreated

urlstringυποχρεωτικό

Παράδειγμα: https://partner.example.com/hooks/foodsoul

descriptionstringυποχρεωτικό

Παράδειγμα: Учётная система

enabledbooleanυποχρεωτικό

Παράδειγμα: true

blockedbooleanυποχρεωτικό

Η συνδρομή απενεργοποιείται αυτόματα μετά από μια σειρά σφαλμάτων

Παράδειγμα: false

count_errorsintegerυποχρεωτικό

Αριθμός διαδοχικών αποτυχημένων αποστολών

Παράδειγμα: 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' => 'el', '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": "el", "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": "el", "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 } ] } }