Získat referenční údaje pro formulář odběru webhooku

GET/api/crm/v2/webhooks_subscriptions.fieldsv2

operationId: webhooksSubscriptions.fields

Autorizace

api-token + language + role

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

webhook_event_idobject (FilterSelect)

valuestring

Příklad: example

typestringpovinné

Příklad: select

optionarray of object

valuestringpovinné

Příklad: example

namestringpovinné

Příklad: All

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

curl -X GET 'https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.fields' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: cs' \
  -H 'role: partner'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.fields', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'cs',
        'role' => 'partner',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.fields", {
    method: "GET",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "cs",
        "role": "partner"
    },
})
const data = await response.json()

import requests

response = requests.request(
    "GET",
    "https://foodsoul.ru/api/crm/v2/webhooks_subscriptions.fields",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "cs",
        "role": "partner",
    },
)
data = response.json()

Odpověď 200

{
  "status": "success",
  "data": {
    "webhook_event_id": {
      "value": "example",
      "type": "select",
      "option": [
        {
          "value": "example",
          "name": "All"
        }
      ],
      "mode": "value_required"
    }
  }
}

Žádosti jsou odesílány na foodsoul.ru — to je hostitel tohoto portálu, jiný vybrat nelze.