Listar suscripciones

GEThttps://api.copayex.com/api/v1/webhooks/subscriptions

Parámetros de solicitud

Campo	Tipo	Ubicación	Requerido	Descripción
`active`	boolean	Query	No	Filtra por estado habilitado.
`event`	string	Query	No	Filtra por evento suscrito.
`url`	string	Query	No	Coincidencia parcial de destino.

Parámetros de respuesta

Devuelve una lista de objetos subscription con la misma forma que al crear una suscripción, pero sin el campo secret. Cada elemento incluye:

Campo	Tipo	Descripción
`id` / `uuid`	number / string	Identificadores de la suscripción.
`clientId`	number	Cliente al que pertenece.
`url`	string	Endpoint donde se envían los webhooks.
`events`	string[]	Eventos configurados.
`active`	boolean	Indica si está habilitada.
`secretVersion`	string	Versión del secreto actual.
`createdAt` / `updatedAt`	string (ISO8601)	Timestamps de auditoría.

Ejemplos de solicitud

curl -G "https://api.copayex.com/api/v1/webhooks/subscriptions" \
  -H "Authorization: Bearer <client_access_token>" \
  --data-urlencode "active=true"

const response = await fetch("https://api.copayex.com/api/v1/webhooks/subscriptions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <client_access_token>",
  },
})
 
const data = await response.json()
console.log(data)

import requests
 
headers = {
    "Authorization": "Bearer <client_access_token>"
}
 
response = requests.get(
    "https://api.copayex.com/api/v1/webhooks/subscriptions",
    params={"active": True},
    headers=headers,
    timeout=10,
)
response.raise_for_status()
print(response.json())

Respuesta de ejemplo

[
  {
    "clientId": 1,
    "url": "https://localhost:3443/webhook",
    "events": [
      "payments.item.completed",
      "payments.item.partial_payment",
      "payments.item.payment_failed",
      "payments.item.payment_canceled"
    ],
    "active": true,
    "secretVersion": "v1",
    "id": 3,
    "uuid": "9cf1f29b-1846-41b3-9ebc-f4de8b7ab061",
    "createdAt": "2025-11-11T01:45:11.416Z",
    "updatedAt": "2025-11-11T01:45:11.416Z"
  }
]

Crear suscripción Actualizar suscripción