---
title: "Configurar webhooks"
method: POST
path: "/dda-servicewebhook-webservice/v1/webhook/register"
---

# Configurar webhooks

`POST /dda-servicewebhook-webservice/v1/webhook/register`

Essa API permite realizar a configuração da(s) URL(s) que receberá(ão) as atualizações de status do cadastro, exclusão e de boletos. Veja nosso [artigo](https://developers.celcoin.com.br/docs/sobre-dda#configurar-webhooks) e saiba como realizar a implementação dessa API.

Para atualizar a URL cadastrada, basta realizar uma nova requisição, pois ela irá sobrescrever a configuração anterior.

## Request body

- object
  - `typeEventWebhook` string, required — Tipo de evento da notificação. Pode ser definido como: Subscription, Deletion ou Invoice (um para cada requisição)
  - `url` string, required — O endereço do seu serviço na web.
  - `basicAuthentication` object — Autenticação do tipo Basic. Caso informe essa autenticação, os dois campos da autenticação basic são obrigatórios.
    - `identification` string — Identificação para autenticação.
    - `password` string — Senha para autenticação.
  - `oAuthTwo` object — Autenticação do tipo oAuth. Caso informe essa autenticação, os campos "endpoint", "grantType", "clientId" e "clientSecret", são obrigatórios.
    - `endpoint` string — Url para autenticação. Ex: https://yoursite.azurewebsites.net/oauth
    - `grantType` string — Tipos de concessão. Ex: client_credentials
    - `clientId` string — Identificador do cliente. Ex: CBA114E0-02A7
    - `clientSecret` string — Chave secreta do cliente. Ex: eyJ0eXAiOiJK
    - `scope` string — Escopos registrados com o aplicativo. Ex: vso.profile
    - `state` string — Usado para gerar uma string aleatória e incluir na solicitação. Ex: xcoiv98y2kd22vusuye35
    - `code` string — Tipo de concessão código de autorização do cliente. Ex: 4BV8LHVNl49hy5qKFUiZQm
    - `refreshToken` string — Verificar de tempos em tempos o ID (Access Token). Ex: eAW8CpgUcWCDv5lM+G5RwJ9HKxrOvLIl2G6i5rAFTwIg1Svh8o4WM
    - `contentType` string — Indicar o tipo de mídia para o recurso. Ex: application/json

## Response `200`

200

- object
  - `status` integer
  - `body` object
    - `typeEventWebhook` string
    - `url` string
    - `basicAuthentication` object
      - `identification` string
      - `password` string
    - `oAuthTwo` unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/celcoin/apis/api-para-transa-es.md) · [All operations](https://skmtc.net/celcoin/apis/api-para-transa-es/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/celcoin/api-para-transa-es/revisions/85dd6188a37b/schema)