Saltar al contenido principal

kobana dashboards webhook-deliveries

Comandos de kobana dashboards webhook-deliveries. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
webhook-deliveries listGET /v1/webhook_deliveriesListar entregas de webhook
webhook-deliveries getGET /v1/webhook_deliveries/{id}Consultar entrega de webhook

webhook-deliveries list​

Listar entregas de webhook

kobana dashboards webhook-deliveries list [OPCIONES]

GET /v1/webhook_deliveries

Entregas de todos los endpoints del workspace, de la más reciente a la más antigua, con el tipo de evento y el resumen del endpoint.

Parámetros de consulta

NombreTipoObligatorioDescripción
pageintegernoPágina (comienza en 1). Por defecto: 1.
per_pageintegernoÍtems por página. Por defecto: 20. Máximo: 100.
sort_bystringnoCampo de ordenación. El valor por defecto depende del recurso.
sort_orderstringnoDirección de ordenación. Por defecto: desc. Valores: asc, desc.
statusstringnopending, delivered o failed. Valores: pending, delivered, failed.
webhook_idstringnoSolo entregas de este endpoint de webhook.
date_fromstringnoLímite inferior de created_at (fecha o fecha-hora ISO 8601).
date_tostringnoLímite superior de created_at (fecha o fecha-hora ISO 8601). Una fecha sin hora cubre el día entero (UTC).

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringnoWorkspace en el que actúa la llamada: el id o el public_id que se muestran en Workspaces en el panel. Dentro de la organización del token, los datos viven en workspaces. Puede omitirse mientras la organización tenga un único workspace; con dos o más, omitirlo devuelve 400 workspace_required. Un workspace que no es de la organización devuelve 403 unknown_workspace. Con un token de persona, solo los workspaces a los que ella tiene acceso (los propietarios de la organización alcanzan todos); los demás devuelven 403 workspace_access_denied.

Respuestas

HTTPDescripción
200Página de entregas.
400Solicitud inválida: cuerpo malformado, campo obligatorio ausente o filtro con valor inválido.
404Recurso no encontrado en la organización actual.

webhook-deliveries get​

Consultar entrega de webhook

kobana dashboards webhook-deliveries get [ID] [OPCIONES]

GET /v1/webhook_deliveries/{id}

Devuelve una entrega: la solicitud (redactada), la respuesta, los intentos y el endpoint de destino.

Argumentos de la ruta: id

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringnoWorkspace en el que actúa la llamada: el id o el public_id que se muestran en Workspaces en el panel. Dentro de la organización del token, los datos viven en workspaces. Puede omitirse mientras la organización tenga un único workspace; con dos o más, omitirlo devuelve 400 workspace_required. Un workspace que no es de la organización devuelve 403 unknown_workspace. Con un token de persona, solo los workspaces a los que ella tiene acceso (los propietarios de la organización alcanzan todos); los demás devuelven 403 workspace_access_denied.

Respuestas

HTTPDescripción
200La entrega.
404Recurso no encontrado en la organización actual.