Criar webhook

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

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

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`enable`	`boolean`	Não	—	—
`name`	`string`	Não	—	aceita null
`webhookType`	`WebhookType`	Não	—	—
`url`	`string`	Não	—	aceita null

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

Status	Descrição	Corpo da resposta
`200`	OK	Nenhum corpo de resposta está definido.

Modelos de dados

WebhookDto

Propriedade	Tipo	Obrigatório	Descrição	Restrições
`id`	`integer · int32`	Não	—	—
`enable`	`boolean`	Não	—	—
`name`	`string`	Não	—	aceita null
`webhookType`	`WebhookType`	Não	—	—
`url`	`string`	Não	—	aceita null

WebhookType

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

integer