Atualizar URL, headers, status, versão do contrato ou filtro de tipos

patch

https://webhook-sender-manager-production.iorq.com.br/api/webhook/{webhook_id}

Atualiza a URL, os headers custom, o status, a contract_version e/ou os event_types do webhook; só os campos enviados mudam. Para pausar a entrega envie {"status": "INACTIVE"}; para reativar, {"status": "ACTIVE"}. Não há endpoint de delete — desative com INACTIVE. O signing_secret não muda nem é devolvido aqui.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

webhook_id

string

required

Body Params

webhook_url

uri

headers

object | null

Substitui o conjunto inteiro de headers custom: um nome ausente deixa de ser enviado, e null remove todos. Omitido, os headers gravados seguem. Mesmas regras do registro (até 32, nomes proibidos com 422). Os valores são só de escrita: a resposta traz apenas header_names

status

string

enum

INACTIVE pausa a entrega (fatos que acontecem durante a pausa não geram evento para este webhook); ACTIVE reativa, inclusive um webhook SUSPENDED, limpando suspended_at, suspension_reason e failing_since. Reenviar o status já vigente não muda nada e não zera failing_since. SUSPENDED não é aceito aqui (422)

Allowed:

event_types

array of strings

Defaults to *

Tipos assinados: '', '.' (loan, acquisition, installment, prepayment, charge, repurchase, renegotiation, webhook) ou o tipo exato (ex.: installment.settled). O filtro vale para os fatos publicados em v2, qualquer que seja a contract_version do webhook; fatos ainda publicados em v1 chegam sem passar por ele. Lista vazia é recusada

event_types

contract_version

string

enum

Troca a versão do corpo entregue. A partir da próxima entrega o webhook passa a receber o formato escolhido

Allowed:

v1_failure_status

string

enum

Troca, num webhook v1, como chega a falha de liquidação, antecipação e recompra. Vale a partir da próxima entrega e é reversível

Allowed:

max_attempts

integer

1 to 30

Tentativas de entrega por evento. Omitido, o webhook segue a política da IORQ e acompanha as mudanças dela

Headers

iorq-fund-id

uuid

required

UUID do fundo (credit vehicle). Entregue por e-mail na seção Fundos liberados quando a IORQ provisiona seu acesso. Obrigatório em toda chamada à API operacional (hs-receiver) e ao serviço de webhooks (webhook-sender-manager). Deve corresponder ao fund_id informado no corpo ou na query quando aplicável.

Responses

200Webhook atualizado

400Header iorq-fund-id ausente, com formato inválido ou divergente do legado Fund-Id

401Header Authorization ausente. Token inválido ou expirado devolve 403, não 401

403Token inválido ou expirado (recusado no gateway, corpo {"message": "Forbidden"}); credencial sem acesso ao fundo do header iorq-fund-id; ou credencial sem a permissão desta operação (corpo {"detail": "..."}). A resposta é a mesma para fundo inexistente e fundo de outro cliente

404Recurso não encontrado

409O status do webhook mudou durante a chamada (error_code: WEBHOOK_CONCURRENT_UPDATE), por exemplo porque a IORQ o suspendeu: leia o webhook de novo e repita