Skip to main content
PATCH
Actualizar webhook

Authorizations

Authorization
string
header
required

JWT obtenido desde /v2/auth/login

Path Parameters

id
string
required

Identificador UUID del webhook.

Example:

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

Body

application/json

Campos del webhook a actualizar.

url
string

Nueva URL HTTPS del partner.

Example:

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

description
string

Descripción interna del webhook.

Maximum string length: 255
Example:

"Webhook actualizado"

apiKey
string

API key opcional asociada al webhook.

Example:

"partner-secret"

status
enum<string>

Estado del webhook.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
Example:

"ACTIVE"

events
object

Eventos suscritos.

Response

Webhook actualizado exitosamente.

id
string
required

Identificador único del webhook.

Example:

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

url
string
required

URL configurada para recibir notificaciones.

Example:

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

events
enum<string>[]
required

Eventos configurados.

Available options:
pending_transaction,
processing_transaction,
completed_transaction,
reject_transaction,
failed_transaction,
expired_transaction
Example:
apiKey
object | null

API key asociada al webhook, si existe.

Example:

null

description
object | null

Descripción del webhook.

Example:

"Webhook principal"