Configurar webhook

PUT

/webhooks/set/{id}

Irá ser acionado toda vez que um dos eventos acontecer.

A URL precisa ser https.
Formato da chamada: POST

Eventos disponíveis:

Emissão de NFe

Criação de pedido

Alteração de pedido

Criação de OP

Criação de pessoa

Criação de item

Requisição

Parâmetros Path

enum<string>

requerido

Webhook a ser configurado

Valores permitidos:

createNFecreatePOcreateSaleupdateSalecreateItemcreatePerson

Parâmetros Bodyapplication/json

url

string

requerido

Exemplo

{
    "url": "string"
}

Exemplos de Requisição

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/webhooks/set/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "string"
}'

Respostas

🟢200OK

application/json

Response

Body

success

boolean

opcional

Padrão:

true

message

string

opcional

Padrão:

Webhook atualizado com sucesso

Exemplo

{
    "success": true,
    "message": "Webhook atualizado com sucesso"
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Modificado em 2025-06-11 21:07:04

Página anterior

Listar lotes

Próxima página

Retorna serviços cadastrados