> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upag.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter webhook

> Consulta um webhook pelo ID

Permissão: `webhook.read`

## Endpoint

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.upag.dev/v1/webhooks/aa0e8400-e29b-41d4-a716-446655440000 \
    -H "Authorization: Bearer sk_test_your_api_key"
  ```

  ```javascript Node.js SDK theme={null}
  import { Upag } from 'upag';

  const upag = new Upag('sk_test_your_api_key');

  const webhook = await upag.webhooks.retrieve('aa0e8400-e29b-41d4-a716-446655440000');
  ```
</CodeGroup>

<Note>
  Em produção use `https://api.upag.io/v1` com `sk_live_...`. O SDK escolhe o host pela chave.
</Note>

## Parâmetros

<ParamField path="webhookId" type="string (uuid)" required>
  ID do webhook.
</ParamField>

## Resposta

`200 OK`

```json Response theme={null}
{
  "id": "aa0e8400-e29b-41d4-a716-446655440000",
  "description": "Order events",
  "active": true,
  "url": "https://example.com/webhooks",
  "headers": { "X-Custom": "value" },
  "events": ["charge.paid"],
  "secret": "whsec_abc123...",
  "createdAt": "2026-03-18T09:00:00.000Z",
  "updatedAt": "2026-03-18T09:00:00.000Z"
}
```

Webhook inexistente, excluído ou de outra conta retorna `404` (`WEBHOOK_NOT_FOUND`).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.