Obter o log de envios de webhooks

GET/api/crm/v2/webhooks_logsv2

operationId: webhooksLogs.default

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 8412

date_creation_fromstring

Exemplo: 01/09/2026

date_creation_tostring

Exemplo: 24/09/2026

statusstring

Valores:waitingrunningsuccesserror

firm_webhook_idinteger

Exemplo: 12

idinteger

Exemplo: 5310

pageinteger

Exemplo: 1

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

filtersobject

date_creation_fromobject (FilterDateFrom)

valuestringpode ser nulo

Exemplo: 2026-08-01 00:00:00

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

date_creation_toobject (FilterDateTo)

valuestringpode ser nulo

Exemplo: 2026-08-31 23:59:59

typestringobrigatório

Exemplo: date

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

branch_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

statusobject (FilterEnum)

Filtro de enumeração — lista plana de valores de enum

valuestring

Exemplo: example

typestringobrigatório

Exemplo: select

optionarray of string

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

firm_webhook_idobject (FilterSelectInteger)

valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object

valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Valores:force_shownvalue_required

Exemplo: value_required

paginationobject (Pagination)

max_countintegerobrigatório

Número de itens por página

Exemplo: 30

page_numberintegerobrigatório

Número da página atual; limitado para que o deslocamento não exceda 1000

Exemplo: 1

has_nextbooleanobrigatório

Existe uma próxima página

Exemplo: true

has_previousbooleanobrigatório

Existe uma página anterior

Exemplo: false

listarray of object

idintegerobrigatório

Exemplo: 5310

date_creationstring (DataTimeFormatSQL) obrigatório

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

date_sendingstring (DataTimeFormatSQL) obrigatório

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

firm_webhook_idintegerobrigatório

Exemplo: 12

slugstringobrigatóriopode ser nulo

Exemplo: order.created

urlstringobrigatóriopode ser nulo

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

event_uuidstringobrigatório

Exemplo: 5f0c6b1e-6a1d-4c1e-9d6b-3a7f0e2b8c41

attemptsintegerobrigatório

Exemplo: 2

statusstringobrigatório

Valores:waitingrunningsuccesserror

Exemplo: success

logsarray of object

idintegerobrigatório

Exemplo: 9021

date_creationstring (DataTimeFormatSQL) obrigatório

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

response_codeintegerobrigatório

Exemplo: 500

response_bodystringpode ser nulo

Exemplo: Internal Server Error

response_infoobjectpode ser nulo

durationnumberpode ser nulo

Exemplo: 0.412

errorstringpode ser nulo

Exemplo: operation_timeout

headersobjectpode ser nulo

Valores do dicionário

string

reasonstring

Valores:sending_disabledurl_not_allowedsecret_not_decrypted

Exemplo: url_not_allowed

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/webhooks_logs', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'pt', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

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

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/webhooks_logs", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "date_creation_from": { "value": "2026-08-01 00:00:00", "type": "date", "mode": "value_required" }, "date_creation_to": { "value": "2026-08-31 23:59:59", "type": "date", "mode": "value_required" }, "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "status": { "value": "example", "type": "select", "option": [ "string" ], "mode": "value_required" }, "firm_webhook_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false }, "list": [ { "id": 5310, "date_creation": "2024-05-02 08:31:16", "date_sending": "2024-05-02 08:31:16", "firm_webhook_id": 12, "slug": "order.created", "url": "https://partner.example.com/hooks/foodsoul", "event_uuid": "5f0c6b1e-6a1d-4c1e-9d6b-3a7f0e2b8c41", "attempts": 2, "status": "success" } ], "logs": [ { "id": 9021, "date_creation": "2024-05-02 08:31:16", "response_code": 500, "response_body": "Internal Server Error", "response_info": { "duration": 0.412, "error": "operation_timeout", "headers": { "status": "HTTP/1.1 500 Internal Server Error", "content_type": "text/html" }, "reason": "url_not_allowed" } } ] } }