Get a list of webhook subscriptions

GET/api/crm/v2/webhooks_subscriptionsv2

operationId: webhooksSubscriptions.default

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 8412

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobject

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

settingsobject (WebhooksBranchSettings)

secretstringcan be null

null until the network creates a secret

Example: 9f2c…

enabledbooleanrequired

Example: true

listarray of object

idintegerrequired

Example: 12

date_creationstring (DataTimeFormatSQL) required

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

webhook_event_idintegerrequired

Example: 4

slugstringrequired

Event code sent in the webhook payload

Example: order.created

translation_keystringrequired

Translation key for the event name

Example: webhooksSubscriptionsEvent.orderCreated

urlstringrequired

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

descriptionstringrequired

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

enabledbooleanrequired

Example: true

blockedbooleanrequired

The subscription is automatically disabled after a series of errors

Example: false

count_errorsintegerrequired

Number of consecutive failed deliveries

Example: 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' => 'en', '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": "en", "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": "en", "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 } ] } }