# Criar webhook

Criar webhook. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.

Source: https://zild.ai/pt-BR/docs/api-reference/post-api-Webhook

POST `/Webhook`

Criar webhook. Consulte abaixo parâmetros, corpo da requisição e respostas definidos no contrato OpenAPI.

## Autenticação

**Autenticação obrigatória.** Envie sua chave de API de usuário no header X-API-Key.

## Parâmetros

Esta operação não possui parâmetros de rota, query ou header.

## Corpo da requisição

**Content type:** `application/json` · **Schema:** `WebhookDto`



<table class="api-params"><thead><tr><th>Propriedade</th><th>Tipo</th><th>Obrigatório</th><th>Descrição</th><th>Restrições</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>enable</code></td><td><code>boolean</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>Não</td><td>—</td><td>aceita null</td></tr><tr><td><code>webhookType</code></td><td><code>WebhookType</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>url</code></td><td><code>string</code></td><td>Não</td><td>—</td><td>aceita null</td></tr></tbody></table>



## Exemplo de requisição



```
curl --request POST \
  --url 'https://api.zild.ai/Webhook' \
  --header 'X-API-Key: YOUR_USER_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "enable": true,
  "name": "string",
  "webhookType": 0,
  "url": "string"
}'
```



## Respostas



<table class="api-params"><thead><tr><th>Status</th><th>Descrição</th><th>Corpo da resposta</th></tr></thead><tbody><tr><td><code>200</code></td><td>OK</td><td>Nenhum corpo de resposta está definido.</td></tr></tbody></table>



## Modelos de dados

`WebhookDto`

<table class="api-params"><thead><tr><th>Propriedade</th><th>Tipo</th><th>Obrigatório</th><th>Descrição</th><th>Restrições</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>integer · int32</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>enable</code></td><td><code>boolean</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>Não</td><td>—</td><td>aceita null</td></tr><tr><td><code>webhookType</code></td><td><code>WebhookType</code></td><td>Não</td><td>—</td><td>—</td></tr><tr><td><code>url</code></td><td><code>string</code></td><td>Não</td><td>—</td><td>aceita null</td></tr></tbody></table>

`WebhookType`0 = EvaluationResult; 2 = ConversationEnded; 3 = ConversationDeleted; 4 = CallTransferred; 5 = DocumentNew; 6 = DocumentInProgress; 7 = DocumentTextExtracted; 8 = DocumentError; 9 = DocumentCompleted; 10 = DocumentCancelled

`integer`