Skip to main content
PATCH
Actualizar webhook
Modifica uno o más campos del webhook: url, events, secret, is_active, environment o api_version. Es la forma de subir un webhook creado antes de octubre de 2026 al contrato de ids públicos:
Desde ese momento data.id, sender.id y receiver.id llegan como docu_… y ment_…. Ver Identificadores en el payload.

Authorizations

Authorization
string
header
required

API Key para autenticación. Debe proporcionarse en el header Authorization con el formato: 'Api-Key YOUR-API-KEY' (incluye el prefijo 'Api-Key ' seguido de tu API key)

Path Parameters

webhook_id
string
required

public_id del webhook (dowe_…)

Body

application/json

Campos editables de un webhook. Todos opcionales (PATCH).

url
string<uri>

URL del endpoint que recibirá las notificaciones

events
enum<string>[]

Lista de eventos a notificar

Minimum array length: 1
Available options:
document.issued,
document.delivered,
document.rejected,
document.trace_updated,
document.paid,
document.unpaid,
document.cancelled
secret
string

Clave secreta para verificar la autenticidad de las notificaciones

Maximum string length: 255
is_active
boolean
default:true

Si el webhook está activo

environment
enum<string>
default:both

De qué ambiente recibe eventos de documentos: both (default), production o sandbox. Los eventos que no son de documento (credenciales, folios, cobros, programados) se entregan como producción.

Available options:
both,
production,
sandbox
api_version
enum<integer>
default:2

Formato de los identificadores que viajan en el payload. 2: todos los ids son public_id (docu_… documento, ment_… emisor/receptor, scdo_… programado, fir_… solicitud de folios, dowe_… webhook). 1: ids enteros, el contrato de la API v1. Si se omite, el default sigue la ruta de creación: /v2/webhooks/ crea en 2 y /v1/webhooks/ crea en 1 (desde la plataforma, la versión que ya usa la empresa). Los webhooks creados antes de octubre 2026 quedaron en 1: súbelos con PATCH o desde la plataforma.

Available options:
1,
2

Response

Webhook

id
string

ID único del webhook

Example:

"dowe_2c9e5a1b7f3d0"

url
string<uri>

URL del endpoint que recibe las notificaciones

events
enum<string>[]

Lista de eventos configurados

Available options:
document.issued,
document.delivered,
document.rejected,
document.trace_updated,
document.paid,
document.unpaid,
document.cancelled
events_display
string[]

Nombres legibles de los eventos

Example:
secret
string | null

Clave secreta para verificar notificaciones

is_active
boolean

Si el webhook está activo

last_status_code
integer | null

Último código HTTP de respuesta

last_sent_at
string<date-time> | null

Fecha de último envío

success_rate
number<float>

Tasa de éxito de entregas (0-100)

Required range: 0 <= x <= 100
last_delivery
object | null

Información de la última entrega

created_at
string<date-time>

Fecha de creación

updated_at
string<date-time>

Fecha de última actualización

environment
enum<string>

De qué ambiente recibe eventos de documentos: both (default), production o sandbox. Los eventos que no son de documento (credenciales, folios, cobros, programados) se entregan como producción.

Available options:
both,
production,
sandbox
api_version
enum<integer>

Formato de los identificadores que viajan en el payload. 2: todos los ids son public_id (docu_… documento, ment_… emisor/receptor, scdo_… programado, fir_… solicitud de folios, dowe_… webhook). 1: ids enteros, el contrato de la API v1. Si se omite, el default sigue la ruta de creación: /v2/webhooks/ crea en 2 y /v1/webhooks/ crea en 1 (desde la plataforma, la versión que ya usa la empresa). Los webhooks creados antes de octubre 2026 quedaron en 1: súbelos con PATCH o desde la plataforma.

Available options:
1,
2