Desarrolladores

Registrar un endpoint de webhook

POST
/webhooks/endpoints

Registra una URL https pública para los tipos de evento elegidos. No recibe nada hasta que verify_webhook_endpoint tiene éxito. El secret en texto plano (whsec_…) aparece solo en esta respuesta y no puede volver a leerse; guárdalo ahora para verificar las entregas.

Autorización

headerAutorizaciónBearer <token>

Una API Key creada en la configuración de la cuenta, enviada como Authorization: Bearer <key>. Incluye los Scopes seleccionados al crearla.

Cuerpo de la solicitud

application/json
  1. body
url*string
Longitud1 <= length <= 2048
eventTypes*array<>
Elementos1 <= items

Cuerpo de la respuesta

Correcto.

application/json
  1. response
endpoint*
secret*string
Solicitud de ejemplo
curl -X POST 'https://ximagesplitter.com/api/v1/webhooks/endpoints' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "string",
  "eventTypes": [
    "generation.queued"
  ]
}'
Respuesta de ejemplo
{
  "endpoint": {
    "id": "string",
    "url": "string",
    "eventTypes": [
      "generation.queued"
    ],
    "status": "unverified",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "secret": "string"
}