Gauti žiniatinklio kabliukų prenumeratų sąrašą

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 8412

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

settingsobject (WebhooksBranchSettings)

secretstringgali būti null

null, kol tinklas nesukūrė slaptažodžio

Pavyzdys: 9f2c…

enabledbooleanprivalomas

Pavyzdys: true

listarray of object

idintegerprivalomas

Pavyzdys: 12

date_creationstring (DataTimeFormatSQL) privalomas

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

webhook_event_idintegerprivalomas

Pavyzdys: 4

slugstringprivalomas

Įvykio kodas, perduodamas webhook turinyje

Pavyzdys: order.created

translation_keystringprivalomas

Įvykio pavadinimo vertimo raktas

Pavyzdys: webhooksSubscriptionsEvent.orderCreated

urlstringprivalomas

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

descriptionstringprivalomas

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

enabledbooleanprivalomas

Pavyzdys: true

blockedbooleanprivalomas

Prenumerata automatiškai išjungiama po kelių klaidų

Pavyzdys: false

count_errorsintegerprivalomas

Iš eilės nesėkmingų siuntimų skaičius

Pavyzdys: 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' => 'lt', '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": "lt", "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": "lt", "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 } ] } }