---
title: "Criar um webhook"
method: POST
path: "/{companyId}/apps/{appId}/webhooks"
tags: ["Webhook"]
---

# Criar um webhook

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

## Request

- Base URL: `https://api.sandbox.empresas.btgpactual.com`
- URL: `https://api.sandbox.empresas.btgpactual.com/{companyId}/apps/{appId}/webhooks`
- 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

## Request body

- WebhookBody
  - `appId` string, required: clientId
  - `endpoint` string, required: Endpoint do webhook a ser criado
  - `description` string: Descrição do webhook
  - `events` string[], required: eventos dos produtos que deseja receber
  - `messageFilter` object: Opção para filtrar mensagem de webhook com base em um valor da mensagem recebida
  - `tags` object: tags do webhook
  - `idAlias` string
  - `secret` string

## Response `200`

Success

- PostResponse
  - `webhookId` string: Id único de um webhook cadastrado
  - `appId` string: Assume o valor do seu Client Id
  - `endpoint` string: URL que deseja cadastrar no webhook
  - `key` string
  - `events` string[]: Eventos que deseja assinar no webhook
  - `secret` string: secret key do 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)
