Ir al contenido

webhook

El dominio webhook tiene 5 acciones. En la superficie meta se alcanzan todas a través de arcane_webhook; en la individual, cada una es una herramienta propia; en la dinámica se ejecutan con arcane_execute_action y el ID canónico.

AcciónTítuloTipo
webhook.createCreate webhookescritura
webhook.deleteDelete webhookdestructiva
webhook.listList webhookslectura
webhook.triggerTrigger a webhookescritura
webhook.updateUpdate webhookescritura

Create webhook

Create a webhook that triggers a container or stack update. The token is only returned once.

  • Tipo: escritura
  • Parámetros obligatorios: actionType, name, targetId, targetType
  • Meta-herramienta: arcane_webhook con "action": "create"
  • Herramienta individual: arcane_webhook_create
  • Ruta de Arcane: POST /api/environments/{id}/webhooks
  • ID de operación: create-webhook
  • Uso: targetType and actionType must match: container (update, start, stop, restart, redeploy, with targetId a container ID or name from container.list, which on the local environment must exist now, else the call fails with 400 ‘target container not found’), project (update, up, down, restart, redeploy, with targetId from project.list), gitops (sync, with targetId from gitops.list), updater (run, whole environment, pass targetId as ""). The result holds id and the full token (arc_wh_…), returned only this once. Store it for webhook.trigger, since webhook.list shows just tokenPrefix. The webhook is created enabled. Needs the webhooks:create permission.
  • Acciones relacionadas: webhook.trigger, webhook.list, container.list, project.list, gitops.list

Delete webhook

Delete a webhook by ID

  • Tipo: destructiva — exige confirm: true
  • Parámetros obligatorios: webhookId
  • Meta-herramienta: arcane_webhook con "action": "delete"
  • Herramienta individual: arcane_webhook_delete
  • Ruta de Arcane: DELETE /api/environments/{id}/webhooks/{webhookId}
  • ID de operación: delete-webhook
  • Uso: webhookId from webhook.list. Removes the webhook permanently and its token stops working at once (webhook.trigger then returns 404). Use webhook.update with enabled=false to pause it instead.
  • Acciones relacionadas: webhook.list, webhook.update

List webhooks

List all webhooks configured for this environment

  • Tipo: lectura
  • Parámetros obligatorios: ninguno
  • Meta-herramienta: arcane_webhook con "action": "list"
  • Herramienta individual: arcane_webhook_list
  • Ruta de Arcane: GET /api/environments/{id}/webhooks
  • ID de operación: list-webhooks
  • Uso: Source of every webhookId: returns the environment’s webhooks newest first with id, name, targetType, actionType, targetId, targetName, enabled, lastTriggeredAt and tokenPrefix. The full token is never listed. If it was lost, delete the webhook and create a new one.
  • Acciones relacionadas: webhook.create, webhook.update, webhook.delete

Trigger a webhook

Fire a webhook by its token, running the action it is configured for (redeploy a project, update a container, run a GitOps sync…). This is the public endpoint external systems call, and it needs no credential besides the token

  • Tipo: escritura
  • Parámetros obligatorios: token
  • Meta-herramienta: arcane_webhook con "action": "trigger"
  • Herramienta individual: arcane_webhook_trigger
  • Ruta de Arcane: POST /api/webhooks/trigger/{token}
  • ID de operación: webhook-trigger
  • Uso: token is the full arc_wh_… value returned once by webhook.create (webhook.list only shows tokenPrefix). Returns status accepted at once and runs the action in the background. A disabled webhook fails with 403, an unknown or deleted token with 404. Check the outcome with event.list (type webhook.trigger: ‘Webhook triggered’ on success, ‘Webhook trigger failed’ with the error otherwise).
  • Acciones relacionadas: webhook.create, webhook.list, event.list

Update webhook

Update a webhook’s enabled state

  • Tipo: escritura
  • Parámetros obligatorios: webhookId, enabled
  • Meta-herramienta: arcane_webhook con "action": "update"
  • Herramienta individual: arcane_webhook_update
  • Ruta de Arcane: PATCH /api/environments/{id}/webhooks/{webhookId}
  • ID de operación: update-webhook
  • Uso: Only toggles enabled (required boolean): name, target and action cannot be changed, so delete and recreate for that. webhookId from webhook.list. A disabled webhook keeps its token, and webhook.trigger answers 403 until it is enabled again.
  • Acciones relacionadas: webhook.list, webhook.trigger, webhook.delete