Obtener la lista de suscripciones a webhooks

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 8412

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

settingsobject (WebhooksBranchSettings)

secretstringpuede ser nulo

null, hasta que la red cree el secreto

Ejemplo: 9f2c…

enabledbooleanobligatorio

Ejemplo: true

listarray of object

idintegerobligatorio

Ejemplo: 12

date_creationstring (DataTimeFormatSQL) obligatorio

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

webhook_event_idintegerobligatorio

Ejemplo: 4

slugstringobligatorio

El código del evento que se transmite en el cuerpo del webhook

Ejemplo: order.created

translation_keystringobligatorio

Clave de traducción del nombre del evento

Ejemplo: webhooksSubscriptionsEvent.orderCreated

urlstringobligatorio

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

descriptionstringobligatorio

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

enabledbooleanobligatorio

Ejemplo: true

blockedbooleanobligatorio

La suscripción se desactiva automáticamente después de una serie de errores

Ejemplo: false

count_errorsintegerobligatorio

Número de envíos fallidos consecutivos

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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 } ] } }