Configuração para Recebimento de Movimentações/Tracking dos Pedidos via API

POST

https://api.octalog.com.br/webhook/configurancao

Após realizar as configurações necessárias, sua API passará a receber as atualizações de movimentação (tracking) dos pedidos.

Parâmetros de Configuração:

A API deve estar configurada em um ambiente HTTPS.

É possível incluir parâmetros personalizados no header durante a configuração.

A data de início do serviço pode ser, no máximo, 5 dias retroativos à data atual.

Defina quais status deseja receber em sua API. Para isso, utilize o serviço de "Lista de Status de Atividade" para consultar os ID’s dos status disponíveis.

Informe um ou mais contatos técnicos. Caso ocorra um erro, o sistema enviará um alerta por e-mail, e poderá desativar automaticamente o serviço. Para reativar o serviço de webhook, basta reenviar a solicitação de configuração via POST.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
    "URL": "https://url-sua-api/",
    "LimiteEnvio": 99,
    "AtivoWebhook": false,
    "DataInicioEnvio": "2024-12-14 11:02:09.000",
    "Header": [
        "Authorization:5sh8sf4h"
    ],
    "IDStatus": [
        4
    ],
    "ContatoTecnico": [
        {
            "Nome": "Joao",
            "Email": "joao@gmail.com",
            "Celular": "1199998888"
        }
    ]
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.octalog.com.br/webhook/configurancao' \
--header 'token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "URL": "https://url-sua-api/",
    "LimiteEnvio": 99,
    "AtivoWebhook": false,
    "DataInicioEnvio": "2024-12-14 11:02:09.000",
    "Header": [
        "Authorization:5sh8sf4h"
    ],
    "IDStatus": [
        4
    ],
    "ContatoTecnico": [
        {
            "Nome": "Joao",
            "Email": "joao@gmail.com",
            "Celular": "1199998888"
        }
    ]
}'

Respostas

🟢200Success

application/json

Bodyapplication/json

Exemplo

{}

Página anterior

Exemplo de Retorno do WebHook

Próxima página

Verificação a configuração do Webhook