URL base

Todas las rutas son relativas a https://tu-empresa.chainlink.mx (el subdominio de tu tenant) y requieren un token Bearer. Consulta Autenticación y Convenciones.

En esta página

GET Listar webhooks
POST Crear webhook
DELETE Eliminar webhook

GET /api/v1/webhooks

Listar webhooks

Lista todas las suscripciones a webhooks del tenant, de la más reciente a la más antigua.

Sin parámetros.

No usa API Resource; devuelve la colección Eloquent en crudo envuelta en {data:[...]}. El atributo 'secret' está oculto ($hidden) y nunca se serializa. No está paginado (colección completa ordenada por created_at descendente). Requiere el subdominio del tenant. La lectura está abierta a cualquier token autenticado (sin api.permission).

cURL

curl -X GET "https://tu-empresa.chainlink.mx/api/v1/webhooks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"

Respuesta (ejemplo)

{
  "data": []
}

POST /api/v1/webhooks users.manage

Crear webhook

Crea una suscripción a webhook para uno o más eventos.

Cuerpo (JSON)

`url` requerido	string (url)	Endpoint HTTPS/HTTP que recibirá las entregas POST del webhook; máximo 500 caracteres
`events` requerido	array	Lista de nombres de eventos a los que suscribirse; se requiere al menos uno
`events.*` requerido	string	Cada nombre de evento; máximo 100 caracteres
`secret`	string	Secreto de firma opcional para la verificación HMAC; si se omite, el servidor genera automáticamente un secret aleatorio de 64 caracteres hexadecimales

Devuelve 201 con el modelo creado en crudo (el secret se oculta mediante $hidden). Si no se envía 'secret', el servidor almacena uno generado con bin2hex(random_bytes(32)), pero nunca se devuelve en la respuesta. La escritura requiere api.permission:users.manage. Requiere el subdominio del tenant.

Cuerpo del request

{
  "url": "<url>",
  "events": [],
  "events.*": "<events.*>"
}

cURL

curl -X POST "https://tu-empresa.chainlink.mx/api/v1/webhooks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<url>",
  "events": [],
  "events.*": "<events.*>"
}'

Respuesta (ejemplo)

{
  "data": {
    "id": "integer",
    "url": "string",
    "events": "array<string>",
    "is_active": "boolean",
    "failure_count": "integer",
    "last_triggered_at": "null",
    "created_at": "string (ISO 8601 datetime)",
    "updated_at": "string (ISO 8601 datetime)"
  }
}

DELETE /api/v1/webhooks/{id} users.manage

Eliminar webhook

Elimina una suscripción a webhook por su id.

Parámetros de ruta

id requerido integer Clave primaria de la suscripción a eliminar; 404 si no se encuentra

Devuelve 204 No Content con cuerpo nulo en caso de éxito. Usa findOrFail(), por lo que un id inexistente produce un 404. Requiere api.permission:users.manage. Requiere el subdominio del tenant.

cURL

curl -X DELETE "https://tu-empresa.chainlink.mx/api/v1/webhooks/{id}" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Accept: application/json"