---
title: "Cria um webhook"
method: POST
path: "/v1/webhooks"
tags: ["Webhooks"]
---

# Cria um webhook

`POST /v1/webhooks`

## Request

- Base URL: `https://api.sudrel.com.br/api`
- URL: `https://api.sudrel.com.br/api/v1/webhooks`
- Auth: HTTP bearer

Aceita `Idempotency-Key`. O `segredo` vem SÓ nesta resposta. O
ambiente é o da chave (`sdr_test_` cria webhook de sandbox). Chave
restrita a uma empresa não administra webhooks (403 `chave_restrita`).

## Headers

- `Idempotency-Key` string

## Request body

- WebhookEntrada
  - `url` string: URL completa, http(s). Endereço de rede interna é recusado.
  - `eventos` string[]
  - `ativo` boolean
  - `cabecalhos` object[]
    - `nome` string, required
    - `valor` string, required

## Response `201`

Criado. Guarde o `segredo`.

- object
  - `id` string
  - `url` string
  - `eventos` string[]
  - `ativo` boolean
  - `ambiente` 'producao' | 'sandbox'
  - `cabecalhos` object[]: Só os nomes; o valor nunca volta.
    - `nome` string
  - `segredo_anterior_valido_ate` string, date-time, nullable
  - `ultimo_sucesso_em` string, date-time, nullable
  - `aviso_falha_enviado_em` string, date-time, nullable
  - `criado_em` string, date-time
  - `links` object
    - `self` string
    - `entregas` string
  - `segredo` string

## Other responses

- `401`: `nao_autenticado`: chave de API ausente, inválida ou revogada.
- `422`: `validacao`, com os erros em `erros` (`url_invalida`, `url_nao_permitida`, `evento_invalido`, `cabecalho_invalido`).
- `429`: `limite_de_requisicoes` (`retentavel: true`): 120 requisições por minuto por chave, janela fixa de 60 s. Sem `Retry-After`: espere a virada do minuto e repita a MESMA requisição (com a mesma `Idempotency-Key`).

---

[API](https://skmtc.dev/sudrel/apis/api-publica-sudrel-nfs-e-nf-e-e-ct-e.md) · [All operations](https://skmtc.dev/sudrel/apis/api-publica-sudrel-nfs-e-nf-e-e-ct-e/llms.txt) · [OpenAPI document](https://skmtc.dev/sudrel/apis/api-publica-sudrel-nfs-e-nf-e-e-ct-e/revisions/efd7baba9e37?raw)