Criar uma assinatura de webhook

POST/api/crm/v2/webhooks_subscriptions.addv2

operationId: webhooksSubscriptions.add

Autorização

api-token + language + role

Parâmetros de consulta

branch_idintegerobrigatório

Exemplo: 8412

Corpo da solicitação `application/json`

object

webhook_event_idintegerobrigatório

Exemplo: 4

urlstringobrigatório

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

descriptionstringobrigatório

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

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

rowobject

settingsobject (WebhooksBranchSettings)

secretstringpode ser nulo

null, até que a rede crie o segredo

Exemplo: 9f2c…

enabledbooleanobrigatório

Exemplo: true

listarray of object

idintegerobrigatório

Exemplo: 12

date_creationstring (DataTimeFormatSQL) obrigatório

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

webhook_event_idintegerobrigatório

Exemplo: 4

slugstringobrigatório

Código do evento transmitido no corpo do webhook

Exemplo: order.created

translation_keystringobrigatório

Chave de tradução do nome do evento

Exemplo: webhooksSubscriptionsEvent.orderCreated

urlstringobrigatório

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

descriptionstringobrigatório

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

enabledbooleanobrigatório

Exemplo: true

blockedbooleanobrigatório

A assinatura é desativada automaticamente após uma série de erros

Exemplo: false

count_errorsintegerobrigatório

Número de envios consecutivos com falha

Exemplo: 0

curl -X POST 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: partner' \
  -H 'Content-Type: application/json' \
  -d '{"webhook_event_id":4,"url":"https://partner.example.com/hooks/foodsoul","description":"Учётная система"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'partner',
    ],
    'json' => [
        'webhook_event_id' => 4,
        'url' => 'https://partner.example.com/hooks/foodsoul',
        'description' => 'Учётная система',
    ],
]);

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "webhook_event_id": 4,
        "url": "https://partner.example.com/hooks/foodsoul",
        "description": "Учётная система"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/webhooks_subscriptions.add?branch_id=8412",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "partner",
    },
    json={
        "webhook_event_id": 4,
        "url": "https://partner.example.com/hooks/foodsoul",
        "description": "Учётная система",
    },
)
data = response.json()

Resposta 200

{
  "status": "success",
  "data": {
    "row": {
      "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
        }
      ]
    }
  }
}

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Criar uma assinatura de webhook

Autorização

Parâmetros de consulta

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`