Saltar al contenido principal

kobana kadu webhooks

Comandos de kobana kadu webhooks. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
webhooks listGET /v1/webhooksLista webhooks
webhooks createPOST /v1/webhooksCrea webhook
webhooks getGET /v1/webhooks/{id}Detalla el webhook
webhooks updatePATCH /v1/webhooks/{id}Actualiza webhook
webhooks deleteDELETE /v1/webhooks/{id}Elimina webhooks (soft delete)
webhooks rotate-secretPOST /v1/webhooks/{id}/rotate-secretRota el secreto de firma

webhooks list​

Lista webhooks

kobana kadu webhooks list [OPCIONES]

GET /v1/webhooks

Parámetros de consulta

NombreTipoObligatorioDescripción
cursorstringno
limitnumberno
sort_bystringnoCampo en snake_case: created_at (predeterminado), updated_at o un campo filtrable.
sort_orderstringnoPredeterminado: desc. Valores: asc, desc.

Respuestas

HTTPDescripción
200OK
503AS_UNAVAILABLE — la verificación del token no está disponible (Authorization Server fuera de línea o configuración ausente). Intenta de nuevo (Retry-After).

webhooks create​

Crea webhook

kobana kadu webhooks create [OPCIONES]

POST /v1/webhooks

La URL se verifica contra la red interna. signing_secret se devuelve solo en esta respuesta (el replay de idempotencia devuelve null).

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
labelstringsí
urlstring (uri)sí
authstringsíValores: basic, bearer, header.
workspace_idstring (uuid)no
auth_basic_userstringno
auth_basic_passwordstringno
auth_bearer_tokenstringno
auth_header_keystringno
auth_header_valuestringno
subscribed_eventsarray<string>no
emailsarray<object>no

Otros campos y objetos anidados: kobana schema kadu.webhooks.create.

Respuestas

HTTPDescripción
201created
400VALIDATION_ERROR
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (o CONFLICT de la ruta)
422VALIDATION_ERROR — workspace fuera de la organización
503AS_UNAVAILABLE — la verificación del token no está disponible (Authorization Server fuera de línea o configuración ausente). Intenta de nuevo (Retry-After).

webhooks get​

Detalla el webhook

kobana kadu webhooks get [ID] [OPCIONES]

GET /v1/webhooks/{id}

Argumentos de la ruta: id

Respuestas

HTTPDescripción
200OK
404not found
503AS_UNAVAILABLE — la verificación del token no está disponible (Authorization Server fuera de línea o configuración ausente). Intenta de nuevo (Retry-After).

webhooks update​

Actualiza webhook

kobana kadu webhooks update [ID] [OPCIONES]

PATCH /v1/webhooks/{id}

Argumentos de la ruta: id

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
labelstringno
urlstring (uri)no
subscribed_eventsarray<string>no
statusstringnoValores: active, inactive.
emailsarray<object>no
auth_basic_userstringno
auth_basic_passwordstringno
auth_bearer_tokenstringno
auth_header_keystringno
auth_header_valuestringno

Otros campos y objetos anidados: kobana schema kadu.webhooks.update.

Respuestas

HTTPDescripción
200OK
400VALIDATION_ERROR
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (o CONFLICT de la ruta)
503AS_UNAVAILABLE — la verificación del token no está disponible (Authorization Server fuera de línea o configuración ausente). Intenta de nuevo (Retry-After).

webhooks delete​

Elimina webhooks (soft delete)

kobana kadu webhooks delete [ID] [OPCIONES]

DELETE /v1/webhooks/{id}

Exige el nivel delete (o all): write no elimina. Exige la habilitación webhooks.delete. Un webhook declarado en el kadu.yaml (repo_managed) responde 409 REPO_MANAGED: quítalo de allí.

Argumentos de la ruta: id

Respuestas

HTTPDescripción
200OK
404NOT_FOUND
503AS_UNAVAILABLE — la verificación del token no está disponible (Authorization Server fuera de línea o configuración ausente). Intenta de nuevo (Retry-After).

webhooks rotate-secret​

Rota el secreto de firma

kobana kadu webhooks rotate-secret [ID] [OPCIONES]

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

Devuelve el secreto nuevo solo en esta respuesta; el anterior sigue firmando por 24h (el replay de idempotencia devuelve signing_secret: null).

Argumentos de la ruta: id

Respuestas

HTTPDescripción
200OK
404NOT_FOUND
409IDEMPOTENCY_KEY_REUSED / IDEMPOTENCY_REQUEST_IN_PROGRESS (o CONFLICT de la ruta)
503AS_UNAVAILABLE — la verificación del token no está disponible (Authorization Server fuera de línea o configuración ausente). Intenta de nuevo (Retry-After).