---
title: "Alterar a secret de um webhook"
method: POST
path: "/{companyId}/apps/{appId}/webhooks/{webhookId}/secret"
---

# Alterar a secret de um webhook

`POST /{companyId}/apps/{appId}/webhooks/{webhookId}/secret`

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/{companyId}/apps/{appId}/webhooks/{webhookId}/secret`
- Auth: OAuth 2
  - Authorization code: `https://id.empresas.btgpactual.com/oauth2/authorize`
  - Token URL: `https://id.empresas.btgpactual.com/oauth2/token` scopes: `brn:btg:empresas:banking:payroll`

## Path parameters

- `companyId` string, required: CNPJ da empresa
- `appId` string, required: Assume o valor do seu Client Id
- `webhookId` string, required: Id único de um webhook cadastrado

## Request body

- WebhookSecretBody
  - `value` string: Valor utilizado para gerar a secret

## Response `200`

Success

- PostSecretResponse
  - `webhookId` string: Id único de um webhook cadastrado
  - `idAlias` string: Alias que pode ser atribuido ao webhook
  - `appId` string: Assume o valor do seu Client Id
  - `endpoint` string: URL que deseja cadastrar no webhook
  - `description` string: Descrição do webhook
  - `tags` string: Tag do webhook
  - `disabled` boolean: Campo referente ao status de funcionamento do webhook
  - `secret` string: secret key do webhook
  - `key` string
  - `events` string[]: Eventos que deseja assinar no webhook

---

[API](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos.md) - [All operations](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/llms.txt) - [OpenAPI document](https://skmtc.dev/btgpactual/apis/folha-de-pagamentos/revisions/2a24d3da114c?raw)
