API de webhooks

Gestiona la configuración de webhooks de la carga de trabajo. La entrega de callbacks del proveedor queda fuera de esta colección.

Usa Autenticación de la API para las solicitudes protegidas. Los ejemplos usan tus propios IDs de recursos y un token temporal; las respuestas de ejemplo guardadas son sintéticas.

Método	Ruta	Operación
GET	/v1/webhook	Listar webhooks
POST	/v1/webhook	Crear webhook
GET	/v1/webhook/{id}	Obtener webhook
PUT	/v1/webhook/{id}	Actualizar webhook
DELETE	/v1/webhook/{id}	Eliminar webhook

Listar webhooks

GET /v1/webhook

Devuelve una lista paginada de Webhook

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.
page	consulta	no	Número de página
per_page	consulta	no	Elementos por página

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/webhook" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Lista de Webhook

Campos de respuesta

Campo	Tipo	Descripción
data	array
data[].created_at	integer	(marca de tiempo Unix)
data[].deleted_at	integer	(marca de tiempo Unix)
data[].external_id	string	ID externo del proveedor (por ejemplo, ID del hook)
data[].provider	string	Valores permitidos: github, bitbucket.
data[].status	string	Valores permitidos: active, inactive.
data[].team_id	string
data[].updated_at	integer	(marca de tiempo Unix)
data[].webhook_id	string
data[].workload_id	string
pagination	object
pagination.page	integer	Número de página actual
pagination.per_page	integer	Número de elementos por página
pagination.total	integer	Número total de elementos

Ejemplo ilustrativo; no es una respuesta real:

{
  "data": [
    {
      "created_at": 1791072000,
      "deleted_at": 0,
      "external_id": "example",
      "provider": "github",
      "status": "active",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "webhook_id": "000000000000000000000000001",
      "workload_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Crear webhook

POST /v1/webhook

Crea un nuevo Webhook

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Campos de la solicitud (el cuerpo contiene un ejemplo editable):

Campo	Tipo	Obligatorio	Descripción
external_id	string	no	ID externo del proveedor (por ejemplo, ID del hook)
provider	string	sí	Valores permitidos: github, bitbucket.
status	string	sí	Valores permitidos: active, inactive. Valor predeterminado: "active".
team_id	string	sí
workload_id	string	sí

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/webhook" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "provider": "github",
  "status": "active",
  "team_id": "YOUR_TEAM_ID",
  "workload_id": "YOUR_WORKLOAD_ID"
}
JSON

Reemplaza los marcadores YOUR_* del cuerpo antes de enviar la solicitud. El heredoc entrecomillado conserva el JSON literal.

Respuesta: HTTP 201

Webhook creado

Campos de respuesta

Campo	Tipo	Descripción
created_at	integer	(marca de tiempo Unix)
deleted_at	integer	(marca de tiempo Unix)
external_id	string	ID externo del proveedor (por ejemplo, ID del hook)
provider	string	Valores permitidos: github, bitbucket.
status	string	Valores permitidos: active, inactive.
team_id	string
updated_at	integer	(marca de tiempo Unix)
webhook_id	string
workload_id	string

Ejemplo ilustrativo; no es una respuesta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_id": "example",
  "provider": "github",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "webhook_id": "000000000000000000000000001",
  "workload_id": "000000000000000000000000001"
}

Obtener webhook

GET /v1/webhook/{id}

Devuelve un único Webhook

Configura webhook_id usando IDs de tus propias respuestas de la API.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
id	ruta	sí	Identificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/webhook/${ADIOS_WEBHOOK_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Webhook

Campos de respuesta

Campo	Tipo	Descripción
created_at	integer	(marca de tiempo Unix)
deleted_at	integer	(marca de tiempo Unix)
external_id	string	ID externo del proveedor (por ejemplo, ID del hook)
provider	string	Valores permitidos: github, bitbucket.
status	string	Valores permitidos: active, inactive.
team_id	string
updated_at	integer	(marca de tiempo Unix)
webhook_id	string
workload_id	string

Ejemplo ilustrativo; no es una respuesta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_id": "example",
  "provider": "github",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "webhook_id": "000000000000000000000000001",
  "workload_id": "000000000000000000000000001"
}

Actualizar webhook

PUT /v1/webhook/{id}

Actualiza un Webhook existente

Configura webhook_id usando IDs de tus propias respuestas de la API.

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Campos de la solicitud (el cuerpo contiene un ejemplo editable):

Campo	Tipo	Obligatorio	Descripción
external_id	string	no	ID externo del proveedor (por ejemplo, ID del hook)
provider	string	sí	Valores permitidos: github, bitbucket.
status	string	sí	Valores permitidos: active, inactive. Valor predeterminado: "active".
team_id	string	sí
workload_id	string	sí

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
id	ruta	sí	Identificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/webhook/${ADIOS_WEBHOOK_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "provider": "github",
  "status": "active",
  "team_id": "YOUR_TEAM_ID",
  "workload_id": "YOUR_WORKLOAD_ID"
}
JSON

Reemplaza los marcadores YOUR_* del cuerpo antes de enviar la solicitud. El heredoc entrecomillado conserva el JSON literal.

Respuesta: HTTP 200

Webhook actualizado

Campos de respuesta

Campo	Tipo	Descripción
created_at	integer	(marca de tiempo Unix)
deleted_at	integer	(marca de tiempo Unix)
external_id	string	ID externo del proveedor (por ejemplo, ID del hook)
provider	string	Valores permitidos: github, bitbucket.
status	string	Valores permitidos: active, inactive.
team_id	string
updated_at	integer	(marca de tiempo Unix)
webhook_id	string
workload_id	string

Ejemplo ilustrativo; no es una respuesta real:

{
  "created_at": 1791072000,
  "deleted_at": 0,
  "external_id": "example",
  "provider": "github",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "webhook_id": "000000000000000000000000001",
  "workload_id": "000000000000000000000000001"
}

Eliminar webhook

DELETE /v1/webhook/{id}

Elimina un Webhook

Configura webhook_id usando IDs de tus propias respuestas de la API.

Esta solicitud modifica datos o inicia una acción. Revisa el destino y el cuerpo antes de enviarla.

Autenticación: token bearer y la cabecera de equipo que se muestra a continuación.

Parámetros

Nombre	Ubicación	Obligatorio	Descripción
id	ruta	sí	Identificador del recurso obtenido de los resultados de la API de tu equipo.
X-Tenant-ID	cabecera	sí	ID del equipo activo. Debe coincidir con el tenant vinculado al token de diagnóstico.

Ejemplo de solicitud

Configura ADIOS_API_URL=https://api.adios.dev. Para las solicitudes protegidas, configura ADIOS_ACCESS_TOKEN y ADIOS_TEAM_ID como en el inicio rápido. Configura las variables adicionales ADIOS_* a partir de los resultados de tus propios recursos.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/webhook/${ADIOS_WEBHOOK_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Respuesta: HTTP 200

Recurso eliminado.

Campos de respuesta

Campo	Tipo	Descripción
message	string

Ejemplo ilustrativo; no es una respuesta real:

{
  "message": "Deleted successfully"
}