Pular para o conteúdo
platform
PT EN

Webhooks e eventos · Webhook assíncrono

Webhook de pedidos

Quando dispara

Depois que o pedido é gerado na plataforma, a CWS Platform envia a notificação para o endpoint da sua loja. A geração do pedido não depende da resposta do seu sistema: o webhook existe para o ERP processar o pedido no próprio ritmo.

Na versão simplificada o payload traz a identificação do pedido e o status. O conteúdo completo é buscado na API, com o id recebido.

Payload de exemplo

Exemplo da coleção pública. A URL é a do seu sistema: o endereço abaixo é só ilustrativo.

POST https://api.exemplo-cliente.com.br/webhook/pedido
Content-Type: application/json

{
    "approvalWorkflow": false,
    "dateCreated": "2025-04-23T12:17:24Z",
    "id": 1503066,
    "lastUpdated": "2025-04-23T12:18:01Z",
    "orderId": 1457551,
    "partnerCompanyName": "Nome da Loja Exemplo",
    "partnerDocument": "61.234.985/0222-64",
    "status": "AWAITING_PAYMENT",
    "workflowIsApproved": false
}

Como responder

É uma comunicação assíncrona: a plataforma envia a notificação e não aguarda uma resposta para continuar os seus processos.

Use o id do payload para buscar os detalhes do pedido e, a partir daí, devolver o andamento pela API: status, nota fiscal e acompanhamento dos itens.

A coleção não publica política de reenvio para este webhook. Um desenho seguro combina o webhook com uma consulta periódica da listagem de pedidos por data de alteração, que recupera o que o seu endpoint não tiver recebido.

O que a coleção documenta

Este é um exemplo de payload para o Webhook de Pedidos na versão simplificada. Sua loja recebe esta notificação e pode usar o id para buscar os detalhes completos na API da CWS.

Autenticação do seu endpoint

Visão Geral da Autenticação

Para que a CWS possa enviar notificações de Webhook (Pedidos e Clientes) de forma segura, nosso sistema primeiro se autenticará no seu para obter um token de acesso.

Você deve nos fornecer os detalhes do seu endpoint de autenticação para que possamos configurá-lo.

Estrutura do Endpoint de Token (Sua Responsabilidade)

Você precisará construir um endpoint POST (ex: /token) que, ao receber as credenciais corretas, retorne um token de acesso. A resposta deve seguir o padrão OAuth2:

{
    "access_token": "SEU_TOKEN_GERADO",
    "expires_in": 3600
}

Abaixo estão três exemplos reais de como seu endpoint de token pode ser configurado.

Exemplo 1: Fluxo client_credentials com Basic Auth

Como funciona: Suas credenciais (clientId e clientSecret) são combinadas, codificadas em Base64 e enviadas no Header Authorization.

Requisição que a CWS fará para seu endpoint de token:

curl --location 'https://api.cliente.com.br/oauth/access-token' \
--header 'Authorization: Basic [SUAS_CREDENCIAS_EM_BASE64]' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'

Exemplo 2: Fluxo com clientId e clientSecret no Body

Como funciona: Suas credenciais são enviadas diretamente no corpo (body) da requisição em formato JSON.

Requisição que a CWS fará para seu endpoint de token:

curl --location 'https://api.cliente.com.br/v1/token' \
--header 'User-Agent: CWS Digital' \
--header 'Content-Type: application/json' \
--data '{
    "clientId": "SEU_CLIENT_ID",
    "clientSecret": "SEU_CLIENT_SECRET"
}'

Exemplo 3: Fluxo com Credenciais em Headers Customizados

Como funciona: Um modelo não padrão onde o usuário e a senha são enviados em headers específicos, em vez de usar Authorization ou o corpo da requisição.

Requisição que a CWS fará para seu endpoint de token:

curl --location --request POST 'https://api.cliente.com.br/rest/api/oauth2/v1/token?grant_type=password' \
--header 'username: SEU_USUARIO' \
--header 'password: SUA_SENHA'

Endpoints relacionados

Webhooks e eventos

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.