PEPINO ZAPdocs
Referência da APIWebhooks

Lista seus webhooks

Ver como Markdown
GET
/v1/webhooks

Lista todos os webhooks cadastrados no Projeto da API key, com o estado atual de cada um: eventos assinados, se esta habilitado e os marcadores de saude da entrega (lastSuccessAt, lastFailureAt e lastFailureReason) que o dispatcher atualiza a cada tentativa. O secret NUNCA e retornado aqui — ele so aparece uma unica vez, na criacao. Escopado ao seu Projeto (modo test/live conforme o host/ambiente da API key).

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/webhooks"
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "enabled": true,
      "lastSuccessAt": "2019-08-24T14:15:22Z",
      "lastFailureAt": "2019-08-24T14:15:22Z",
      "lastFailureReason": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key ausente ou invalida"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Projeto inativo ou sem permissao"
  }
}