Criar Webhooks

É possível receber nossos processamentos no momento em que eles são finalizados. Para isso, é necessário a criação de um Webhook para receber a nossa requisição. Só é possível criar um tipo de Webhook por vez, então caso queira alterar os dados, será necessário excluir o Webhook atual.

A seguir será mostrado como efetuar o cadastro via API. É importante notar que a url do webhook deverá possuir o padrão com ":id". Será nesse parâmetro que iremos enviar o id do documento processado. Verifique a seguir os exemplos.

Serviço de documentos - Criação de Webhook

POST URL Ambiente/api_document/document_webhooks

Header

Identificador	Valor
Content-type	application/json
Accept	application/json
X-API-KEY	[api_key]

Payload

Parâmetro	Descrição	Obrigatório	Tipo	Exemplos
name	Nome descritivo do Webhook	Sim	String	Webhook 1
type	Código interno do tipo do Webhook (0-Documento finalizado)	Sim	Integer	0
method	Método a ser enviado (POST, PUT, GET, DELETE)	Sim	String	"POST"
headers	Headers a ser enviado	Não	JSON	{"Content-Type": "application/json"}
headerAuth	Qual será o header de authorização (Bearer)	Não	String	"Bearer"
url	URL a ser enviada	Sim	String	"http://localhost:5000/ocr_feedback/:id"
authorization	Header de autorização (caso deseje uma autorização fixa)	Não	String	"Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJI..."
authorizationUrl	Url para autenticação no momento do disparo do webhook	Não	String	"http://localhost:5000/login"
authorizationMethod	Método para autenticação no momento do disparo do webhook	Não	String	"POST"
authorizationHeaders	Headers para autenticação no momento do disparo do webhook	Não	JSON	{"Content-Type": "application/x-www-form-urlencoded"}
authorizationBody	Body para autenticação no momento do disparo do webhook	Não	JSON	{"username": "root", "password": "root"}
authorizationResponseTokenAttr	Nome do atributo do retorno da autenticação que teráo o access token	Não	JSON	"access_token"

Retorno

Status code 200

Retorna o webhook criado.

Exemplo

{
    "id": "a7046a49-1fe0-483d-b220-cd93fe50a3a9",
    "clientId": "113d37ed-6b47-46b6-bc50-bf5d64ad3a94",
    "name": "Webhook 1",
    "type": 0,
    "method": "POST",
    "headers": {
        "Content-Type": "application/json"
    },
    "headerAuth": "Bearer",
    "url": "http://localhost:5000/ocr_feedback/:id",
    "authorization": null,
    "authorizationUrl": "http://localhost:5000/login",
    "authorizationMethod": "POST",
    "authorizationHeaders": {
        "Content-Type": "application/x-www-form-urlencoded"
    },
    "authorizationResponseTokenAttr": "access_token",
    "createdAt": "2024-04-11T14:12:33.741194-03:00",
    "updatedAt": "2024-04-11T14:12:33.741194-03:00"
}