Enable or disable branch webhooks

POST/api/crm/v2/webhooks_subscriptions.update_settingsv2

operationId: webhooksSubscriptions.updateSettings

Enables or disables branch webhooks. When enabled for the first time, a signature secret is generated, so the branch settings are returned in the response.

Authorization

api-token + language + role

Query parameters

branch_idintegerrequired

Example: 8412

Request body `application/json`

object

enabledbooleanrequired

Disables all branch subscriptions at once

Example: true

Responses

OK

object

statusstringrequired

Values:successerror

Example: success

dataobject

settingsobject (WebhooksBranchSettings)

secretstringcan be null

null until the network creates a secret

Example: 9f2c…

enabledbooleanrequired

Example: true

curl -X POST 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: en' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'en',
        'role' => 'partner',
    ],
    'json' => [
        'enabled' => true,
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "enabled": true
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.update_settings?branch_id=8412",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "en",
        "role": "partner",
    },
    json={
        "enabled": True,
    },
)
data = response.json()

Response 200

{
  "status": "success",
  "data": {
    "settings": {
      "secret": "9f2c…",
      "enabled": true
    }
  }
}

Requests are sent to foodsoul.pro — the host of this portal; you cannot choose another one.