Crear suscripción

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

Parámetros de solicitud

Campo	Tipo	Ubicación	Requerido	Descripción
`url`	string (HTTPS)	Body (JSON)	Sí	Endpoint público que recibirá eventos.
`events`	string[]	Body (JSON)	Sí	Lista de eventos a suscribir.

Eventos disponibles:

payments.item.completed
payments.item.partial_payment
payments.item.payment_failed
payments.item.payment_canceled

Parámetros de respuesta

El endpoint devuelve un objeto con dos partes:

subscription – Metadatos de la suscripción creada.
secret – Secreto firmado que se muestra una única vez (guardalo de inmediato).

Campos relevantes de subscription:

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

Campos relevantes de la respuesta:

Campo	Tipo	Descripción
`subscription`	object	Objeto con los campos detallados arriba.
`secret`	string	Secreto que se muestra una sola vez tras la creación.

Ejemplos de solicitud

curl -X POST "https://api.copayex.com/api/v1/webhooks/subscriptions" \
  -H "Authorization: Bearer <client_access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://webhook.site/webhook",
    "events": [
      "payments.item.completed",
      "payments.item.partial_payment",
      "payments.item.payment_failed",
      "payments.item.payment_canceled"
    ]
  }'

const response = await fetch(
  "https://api.copayex.com/api/v1/webhooks/subscriptions",
  {
    method: "POST",
    headers: {
      Authorization: "Bearer <client_access_token>",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      url: "https://webhook.site/webhook",
      events: [
        "payments.item.completed",
        "payments.item.partial_payment",
        "payments.item.payment_failed",
        "payments.item.payment_canceled",
      ],
    }),
  }
);
 
const data = await response.json();
console.log(data);

import requests
 
payload = {
    "url": "https://webhook.site/webhook",
    "events": [
        "payments.item.completed",
        "payments.item.partial_payment",
        "payments.item.payment_failed",
        "payments.item.payment_canceled",
    ],
}
 
headers = {
    "Authorization": "Bearer <client_access_token>",
    "Content-Type": "application/json",
}
 
response = requests.post(
    "https://api.copayex.com/api/v1/webhooks/subscriptions",
    json=payload,
    headers=headers,
    timeout=10,
)
response.raise_for_status()
print(response.json())

Respuesta de ejemplo

{
  "subscription": {
    "clientId": 1,
    "url": "https://webhook.site/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"
  },
  "secret": "86a9ba81f17e455b7d21bb6fd27772fa8feb36be8********"
}

Eliminar QR Listar suscripciones