Ottenere l'elenco delle sottoscrizioni ai webhook

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 8412

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

settingsobject (WebhooksBranchSettings)

secretstringpuò essere nullo

null, finché la rete non ha creato il segreto

Esempio: 9f2c…

enabledbooleanobbligatorio

Esempio: true

listarray of object

idintegerobbligatorio

Esempio: 12

date_creationstring (DataTimeFormatSQL) obbligatorio

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

webhook_event_idintegerobbligatorio

Esempio: 4

slugstringobbligatorio

Codice dell'evento trasmesso nel corpo del webhook

Esempio: order.created

translation_keystringobbligatorio

Chiave di traduzione del nome dell'evento

Esempio: webhooksSubscriptionsEvent.orderCreated

urlstringobbligatorio

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

descriptionstringobbligatorio

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

enabledbooleanobbligatorio

Esempio: true

blockedbooleanobbligatorio

L'abbonamento viene disattivato automaticamente dopo una serie di errori

Esempio: false

count_errorsintegerobbligatorio

Numero di invii consecutivi non riusciti

Esempio: 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' => 'it', '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": "it", "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": "it", "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 } ] } }