Skip to main content
PATCH
Actualizar webhook

Autorizaciones

Authorization
string
header
requerido

JWT obtenido desde /v2/auth/login

Parámetros de ruta

id
string
requerido

Identificador UUID del webhook.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

Cuerpo

application/json

Campos del webhook a actualizar.

url
string

Nueva URL HTTPS del partner.

Ejemplo:

"https://partner.example.com/webhooks/yp-v2"

description
string

Descripcion interna del webhook.

Maximum string length: 255
Ejemplo:

"Webhook actualizado"

apiKey
string

API key opcional asociada al webhook.

Ejemplo:

"partner-secret"

status
enum<string>

Estado del webhook.

Opciones disponibles:
ACTIVE,
INACTIVE,
SUSPENDED
Ejemplo:

"ACTIVE"

events
object

Eventos suscritos.

Respuesta

Webhook actualizado exitosamente.

id
string
requerido

Identificador unico del webhook.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

url
string
requerido

URL configurada para recibir notificaciones.

Ejemplo:

"https://partner.example.com/webhooks/yp"

events
enum<string>[]
requerido

Eventos configurados.

Opciones disponibles:
pending_transaction,
processing_transaction,
completed_transaction,
reject_transaction,
failed_transaction,
expired_transaction
Ejemplo:
apiKey
object | null

API key asociada al webhook, si existe.

Ejemplo:

null

description
object | null

Descripcion del webhook.

Ejemplo:

"Webhook principal"