Skip to main content

​
➕ Adicionar Webhook à Loja

Este endpoint permite adicionar uma nova URL de webhook à loja, respeitando o limite máximo permitido pelo plano.

​
🔐 Autenticação

Esta rota exige autenticação via API Key, enviada no header da requisição: 
Authorization: SUA_API_KEY_AQUI

​
📥 Parâmetros de Rota

ParâmetroTipoObrigatórioDescrição
storeIdstring (UUID)SimID da loja

​
📥 Body da Requisição

CampoTipoObrigatórioDescrição
urlstringSimURL do endpoint de webhook

​
📋 Exemplo de Requisição

curl --location --request POST "https://api.cabrapi.com.br/stores/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/webhooks" \
--header "Authorization: SUA_API_KEY_AQUI" \
--header "Content-Type: application/json" \
--data '{
  "url": "https://meusistema.com/callback"
}'

​
📊 Exemplo de Resposta (sucesso)

{
  "status": true,
  "code": "SUCCESS",
  "webhooks": [
    "https://meusistema.com/callback1",
    "https://meusistema.com/callback2"
  ],
  "max": 3
}

​
❌ Possíveis Erros

StatusCodeQuando acontece
400INVALID_DATABody inválido ou URL ausente/fora do padrão.
403LIMIT_REACHEDLimite de webhooks atingido para o plano da loja.
404STORE_NOT_FOUNDLoja não existe ou não pertence à sua conta.
500INTERNAL_SERVER_ERRORFalha interna ao processar a requisição.