---
title: "Cadastrar Webhook"
method: POST
path: "/webhook/subscription"
---

# Cadastrar Webhook

`POST /webhook/subscription`

## Request

- Base URL: `https://sandbox.openfinance.celcoin.dev/common/v1`
- URL: `https://sandbox.openfinance.celcoin.dev/common/v1/webhook/subscription`
- Auth: OAuth 2

Confira nosso tutorial -> https://developers.celcoin.com.br/docs/gerenciamento-de-webhook

## Request body

- object
  - `entity` string, required: Identificador do Evento. (deverá ser: (pix-payment-out, pix-payment-in, pix-reversal-in, pix-reversal-out)
  - `webhookUrl` string, required: Rota do Webhook.
  - `auth` object, required
    - `login` string: Login de autenticação (obrigatório quando type for "basic")
    - `pwd` string: Senha (obrigatório quando o type for "basic")
    - `type` string, required: Tipo de autenticação ("basic" ou "JWT")
    - `urlAuth` string
    - `requestType` string
    - `responsePathToken` string
    - `requestAuth` object
  - `context` string, required: Identificador do produto relacionado ao Webhook (deverá ser REDE,CORP,PIX,BAAS,PAGAMENTOS,ONBOARDING)

## Response `200`

200

- object
  - `version` string
  - `status` string
  - `body` object
    - `subscriptionId` string

## Other responses

- `400`: 400
- `401`: 401
- `500`: 500

---

[API](https://skmtc.dev/celcoin/apis/webhook-manager.md) - [All operations](https://skmtc.dev/celcoin/apis/webhook-manager/llms.txt) - [OpenAPI document](https://skmtc.dev/celcoin/apis/webhook-manager/revisions/62ab86d8191a?raw)
