Cadastrar Webhook

POST

/webhook

Registra uma URL de webhook para receber notificações assíncronas sobre eventos de operações no fundo.

O Fund-Id deve ser enviado no header para associar o webhook ao fundo correto. Apenas um webhook por message_type por fundo é permitido.

Campos obrigatórios:

message_type: tipo de evento a receber (ex.: LOAN_UPDATE)

webhook_url: URL HTTPS que receberá os payloads

Campos opcionais:

headers: objeto com headers customizados que a IORQ incluirá em cada chamada ao webhook

Requisição

Authorization

JWT Bearer

Adicionar o parâmetro

Authorization

a Cabeçalhos

Exemplo:

Authorization: ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200

application/json

Operação realizada com sucesso

Bodyapplication/json

🟠422

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://auth-hs.iorq.com.br/webhook' \
--header 'Fund-Id: 374485cf-f6df-467c-b91d-9f14082c6f36' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "message_type": "",
    "webhook_url": ""
}'

Response Example

200 - Exemplo 1

{
    "fund_id": "string",
    "message_type": "LOAN_UPDATE",
    "status": "string",
    "webhook_url": "string",
    "webhook_id": "string",
    "headers": {
        "property1": "string",
        "property2": "string"
    },
    "created_at": "string",
    "updated_at": "string",
    "max_attempts": 7
}

Modificado em 2026-05-14 00:34:05