Webhook-Abonnements abrufen

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 8412

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

settingsobject (WebhooksBranchSettings)

secretstringkann null sein

null, bis das Netzwerk ein Secret erstellt hat

Beispiel: 9f2c…

enabledbooleanerforderlich

Beispiel: true

listarray of object

idintegererforderlich

Beispiel: 12

date_creationstring (DataTimeFormatSQL) erforderlich

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

webhook_event_idintegererforderlich

Beispiel: 4

slugstringerforderlich

Der Ereigniscode, der im Webhook-Body übermittelt wird

Beispiel: order.created

translation_keystringerforderlich

Übersetzungsschlüssel für den Ereignisnamen

Beispiel: webhooksSubscriptionsEvent.orderCreated

urlstringerforderlich

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

descriptionstringerforderlich

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

enabledbooleanerforderlich

Beispiel: true

blockedbooleanerforderlich

Das Abonnement wurde nach einer Reihe von Fehlern automatisch deaktiviert

Beispiel: false

count_errorsintegererforderlich

Anzahl aufeinanderfolgender fehlgeschlagener Zustellungen

Beispiel: 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' => 'de', '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": "de", "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": "de", "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 } ] } }