---
title: "Cadastrar vínculo Webhook"
method: POST
path: "/api/service/sign/v1/webhook"
tags: ["Webhook"]
---

# Cadastrar vínculo Webhook

`POST /api/service/sign/v1/webhook`

Permite adicionar um vínculo de mensagem de atualização (serviço de webhook) para atualizações no estado do envelope (easy.collection) ou para atualizações no estado de qualquer assinatura de um envelope (easy.signature) para o usuário autenticado. Após o vínculo, quando houver a atualização do envelope ou da assinatura, uma mensagem com todos os dados relevantes para aquela atualização é enviada para o endpoint da aplicação cliente configurado por meio desta chamada.

## Request body

- object
  - `webhookType` 'easy.collection' | 'easy.signature' — Tipo de vínculo Webhook. easy.collection - Para atualizações no estado do envelope; easy.signature - para atualizações no estado de qualquer assinatura de um envelope.
  - `urlEndpoint` string — Nome do assinante dentro do envio a ser gerado.

## Response `200`

Retorno de Sucesso para detalhes da criação de um vínculo Webhook

- WebhookCreateResponse[]
  - `webhookId` string — UUID do vínculo Webhook gerado.
  - `methodId` string — UUID do método Webhook gerado.
  - `description` string — Descrição do vínculo Webhook.
  - `urlEndpoint` string — Endpoint configurado para disparo da mensagem de atualização do Webhook.
  - `authType` string — Tipo de autenticação escolhida para o endpoint configurado. No momento suporta apenas `NONE`
  - `authKey` string — Chave de autenticação, quando authType for diferente de `NONE`.
  - `webhookType` string — Tipo de vínculo Webhook. Para atualizações no estado do envelope (easy.collection) ou para atualizações no estado de qualquer assinatura de um envio (easy.signature) para o usuário autenticado. Valores disponíveis: [`easy.collection`, `easy.signature`]
  - `username` string — Nome de usuário no Portal Bry, coletado por meio do token JWT e usado para enfileiramento das mensagens de Webhook.

## Other responses

- `4XX` — Retorno de erro da aplicação
- `5XX` — Retorno de erro da aplicação

---

[API](https://skmtc.net/bry/apis/bry-easy-sign-api-rest.md) · [All operations](https://skmtc.net/bry/apis/bry-easy-sign-api-rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bry/bry-easy-sign-api-rest/revisions/c87e026e87ac/schema)