Obtenir la liste des abonnements aux webhooks

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 8412

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

settingsobject (WebhooksBranchSettings)

secretstringpeut être nul

null, tant que le réseau n'a pas créé de secret

Exemple: 9f2c…

enabledbooleanobligatoire

Exemple: true

listarray of object

idintegerobligatoire

Exemple: 12

date_creationstring (DataTimeFormatSQL) obligatoire

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

webhook_event_idintegerobligatoire

Exemple: 4

slugstringobligatoire

Code de l'événement transmis dans le corps du webhook

Exemple: order.created

translation_keystringobligatoire

Clé de traduction du nom de l'événement

Exemple: webhooksSubscriptionsEvent.orderCreated

urlstringobligatoire

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

descriptionstringobligatoire

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

enabledbooleanobligatoire

Exemple: true

blockedbooleanobligatoire

L’abonnement est automatiquement désactivé après une série d’erreurs

Exemple: false

count_errorsintegerobligatoire

Nombre d'envois consécutifs échoués

Exemple: 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' => 'fr', '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": "fr", "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": "fr", "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 } ] } }