Pular para o conteúdo principal

kobana kadu webhooks

Comandos de kobana kadu webhooks. Toda opção global (Opções globais) vale aqui.

ComandoHTTPDescrição
webhooks listGET /v1/webhooksLista webhooks
webhooks createPOST /v1/webhooksCria webhook
webhooks getGET /v1/webhooks/{id}Detalha o webhook
webhooks updatePATCH /v1/webhooks/{id}Atualiza webhook
webhooks deleteDELETE /v1/webhooks/{id}Remove webhooks (soft delete)
webhooks rotate-secretPOST /v1/webhooks/{id}/rotate-secretGira o segredo de assinatura

webhooks list​

Lista webhooks

kobana kadu webhooks list [OPÇÕES]

GET /v1/webhooks

Parâmetros de consulta

NomeTipoObrigatórioDescrição
cursorstringnão
limitnumbernão
sort_bystringnãoCampo em snake_case: created_at (padrão), updated_at ou um campo filtrável.
sort_orderstringnãoPadrão: desc. Valores: asc, desc.

Respostas

HTTPDescrição
200OK
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

webhooks create​

Cria webhook

kobana kadu webhooks create [OPÇÕES]

POST /v1/webhooks

A URL é conferida contra rede interna. signing_secret é devolvido só nesta resposta (o replay de idempotência devolve null).

Corpo da requisição

NomeTipoObrigatórioDescrição
labelstringsim
urlstring (uri)sim
authstringsimValores: basic, bearer, header.
workspace_idstring (uuid)não
auth_basic_userstringnão
auth_basic_passwordstringnão
auth_bearer_tokenstringnão
auth_header_keystringnão
auth_header_valuestringnão
subscribed_eventsarray<string>não
emailsarray<object>não

Outros campos e objetos aninhados: kobana schema kadu.webhooks.create.

Respostas

HTTPDescrição
201created
400VALIDATION_ERROR
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
422VALIDATION_ERROR — workspace fora da organização
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

webhooks get​

Detalha o webhook

kobana kadu webhooks get [ID] [OPÇÕES]

GET /v1/webhooks/{id}

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404not found
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

webhooks update​

Atualiza webhook

kobana kadu webhooks update [ID] [OPÇÕES]

PATCH /v1/webhooks/{id}

Argumentos do caminho: id

Corpo da requisição

NomeTipoObrigatórioDescrição
labelstringnão
urlstring (uri)não
subscribed_eventsarray<string>não
statusstringnãoValores: active, inactive.
emailsarray<object>não
auth_basic_userstringnão
auth_basic_passwordstringnão
auth_bearer_tokenstringnão
auth_header_keystringnão
auth_header_valuestringnão

Outros campos e objetos aninhados: kobana schema kadu.webhooks.update.

Respostas

HTTPDescrição
200OK
400VALIDATION_ERROR
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

webhooks delete​

Remove webhooks (soft delete)

kobana kadu webhooks delete [ID] [OPÇÕES]

DELETE /v1/webhooks/{id}

Exige o nível delete (ou all): write não apaga. Exige a liberação webhooks.delete. Webhook declarado no kadu.yaml (repo_managed) responde 409 REPO_MANAGED: remova-o de lá.

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).

webhooks rotate-secret​

Gira o segredo de assinatura

kobana kadu webhooks rotate-secret [ID] [OPÇÕES]

POST /v1/webhooks/{id}/rotate-secret

Devolve o segredo novo só nesta resposta; o anterior continua assinando por 24h (o replay de idempotência devolve signing_secret: null).

Argumentos do caminho: id

Respostas

HTTPDescrição
200OK
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (ou CONFLICT da rota)
503AS_UNAVAILABLE — a verificação do token está indisponível (Authorization Server fora do ar ou configuração ausente). Tente de novo (Retry-After).