PEPINO ZAPdocs
Referência da APIWebhooks

Atualiza um webhook (pausar/retomar a entrega)

Ver como Markdown
PATCH
/v1/webhooks/{id}

Atualizacao parcial do webhook. Hoje o unico campo editavel e enabled (true/false), que liga ou desliga a ENTREGA sem perder a configuracao — URL, eventos e secret sao preservados (diferente de remover). Para trocar URL ou eventos, remova e crie outro. O secret nao e retornado aqui (so aparece uma vez, na criacao). Escopado ao Projeto e ao modo (test/live) da credencial; um webhook de outro modo retorna 404.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador do webhook.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

enabled*boolean

Liga (true) ou desliga (false) a entrega do webhook. Obrigatorio — ausente retorna 400. Unico campo editavel hoje.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "enabled": false  }'
{
  "id": "cm5x8wh0001abc123def456",
  "name": "meu-endpoint",
  "url": "https://meusistema.com/webhook/pepinozap",
  "events": [],
  "enabled": false,
  "lastSuccessAt": "2026-06-08T13:42:07Z",
  "lastFailureAt": null,
  "lastFailureReason": null,
  "createdAt": "2026-06-05T12:00:00Z"
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Body invalido"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Instancia nao encontrada"
  }
}