Activer ou désactiver les webhooks de la succursale

POST/api/crm/v2/webhooks_subscriptions.update_settingsv2

operationId: webhooksSubscriptions.updateSettings

Active ou désactive les webhooks de la succursale. Lors de la première activation, un secret de signature est généré, c'est pourquoi les paramètres de la succursale sont renvoyés dans la réponse.

Autorisation

api-token + language + role

Paramètres de requête

branch_idintegerobligatoire

Exemple: 8412

Corps de la requête `application/json`

object

enabledbooleanobligatoire

Désactive immédiatement tous les abonnements de la succursale

Exemple: true

Réponses

OK

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

settingsobject (WebhooksBranchSettings)

secretstringpeut être nul

null, tant que le réseau n'a pas créé de secret

Exemple: 9f2c…

enabledbooleanobligatoire

Exemple: 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: fr' \
  -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' => 'fr',
        '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": "fr",
        "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": "fr",
        "role": "partner",
    },
    json={
        "enabled": True,
    },
)
data = response.json()

Réponse 200

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

Les requêtes sont envoyées à foodsoul.pro — l’hôte de ce portail, il n’est pas possible d’en choisir un autre.