Hangi veebikonksude tellimuste loendi

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idinteger

Näide: 8412

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

settingsobject (WebhooksBranchSettings)

secretstringvõib olla null

null, kuni võrk pole veel saladust loonud

Näide: 9f2c…

enabledbooleankohustuslik

Näide: true

listarray of object

idintegerkohustuslik

Näide: 12

date_creationstring (DataTimeFormatSQL) kohustuslik

Näide: 2024-05-02 08:31:16

webhook_event_idintegerkohustuslik

Näide: 4

slugstringkohustuslik

Sündmuse kood, mis edastatakse webhooki kehas

Näide: order.created

translation_keystringkohustuslik

Sündmuse nime tõlkeklahv

Näide: webhooksSubscriptionsEvent.orderCreated

urlstringkohustuslik

Näide: https://partner.example.com/hooks/foodsoul

descriptionstringkohustuslik

Näide: Учётная система

enabledbooleankohustuslik

Näide: true

blockedbooleankohustuslik

Tellimus on pärast mitut järjestikust viga automaatselt välja lülitatud

Näide: false

count_errorsintegerkohustuslik

Järjestikuste ebaõnnestunud saatmiste arv

Näide: 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' => 'et', '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": "et", "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": "et", "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 } ] } }