Iegūt tīmekļa āķu abonementu sarakstu

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 8412

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

settingsobject (WebhooksBranchSettings)

secretstringvar būt null

null, kamēr tīkls nav izveidojis slepeno atslēgu

Piemērs: 9f2c…

enabledbooleanobligāts

Piemērs: true

listarray of object

idintegerobligāts

Piemērs: 12

date_creationstring (DataTimeFormatSQL) obligāts

Piemērs: 2024-05-02 08:31:16

webhook_event_idintegerobligāts

Piemērs: 4

slugstringobligāts

Notikuma kods, kas tiek nodots webhook paziņojuma ķermenī

Piemērs: order.created

translation_keystringobligāts

Notikuma nosaukuma tulkošanas atslēga

Piemērs: webhooksSubscriptionsEvent.orderCreated

urlstringobligāts

Piemērs: https://partner.example.com/hooks/foodsoul

descriptionstringobligāts

Piemērs: Учётная система

enabledbooleanobligāts

Piemērs: true

blockedbooleanobligāts

Abonements tiek automātiski atspējots pēc vairākiem kļūdu gadījumiem

Piemērs: false

count_errorsintegerobligāts

Neveiksmīgu nosūtīšanas mēģinājumu skaits pēc kārtas

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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 } ] } }