Crear un webhook

POST

/webhooks

curl --request POST \
  --url https://openfactura.co/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "descripcion": "example", "eventos": [ "dte.procesado" ], "activo": true }'

• Open Factura en la nube

Sólo https:// y nunca destinos privados o locales. Máximo 10 por organización. El secreto (whsec_…) se devuelve sólo en esta respuesta.

Permiso: webhooks:manage.

Authorizations

• claveApi
• sesion

Request Body^required

Media typeapplication/json

object

url

required

string

<= 2000 characters

descripcion

Any of:

string

string

<= 200 characters

null

null

eventos

required

Array<string>

>= 1 items

Allowed values: dte.procesado dte.rechazado dte.contingencia dte.invalidado retorno.procesado operaciones_especiales.procesado

activo

boolean

default: true

Responses

201

Webhook creado.

Media typeapplication/json

object

id

required

string

url

required

string

descripcion

string | null

eventos

required

Array<string>

Allowed values: dte.procesado dte.rechazado dte.contingencia dte.invalidado retorno.procesado operaciones_especiales.procesado

activo

required

boolean

creado

required

integer

actualizado

integer | null

secreto

required

Whsec_…: clave de la firma HMAC. Sólo esta vez.

string

Example

{
  "eventos": [
    "dte.procesado"
  ]
}

Headers

RateLimit-Limit

integer

Peticiones permitidas por minuto (sólo con clave de API).

RateLimit-Remaining

integer

Peticiones restantes en la ventana actual (sólo con clave de API).

RateLimit-Reset

integer

Segundos hasta que se reinicia la ventana (sólo con clave de API).

Idempotent-Replayed

string

Allowed values: true

true cuando la respuesta es la guardada de un intento anterior.

400

Cuerpo o parámetros inválidos (details = [{ ruta, mensaje }]), o el DTE no cumple el esquema del MH (details.problemas). Códigos: datos_invalidos, dte_invalido.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

401

Falta sesión, o la clave de API no es válida, fue revocada o expiró. Códigos: no_autenticado.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

403

Falta un permiso (details.permiso) o el origen de la petición con cookie no está permitido. Códigos: sin_permiso, origen_no_permitido.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

409

Falta configurar algo o hay un conflicto. Códigos: sin_organizacion, sin_organizacion_activa, nit_bloqueado, emisor_no_configurado, credenciales_incompletas, sin_punto_venta, estado_invalido, ambiente_distinto, retorno_excedido, retorno_vigente, idempotencia_distinta, idempotencia_en_curso, cliente_repetido, producto_repetido, codigo_repetido, sin_archivo, limite_webhooks, simulador_inactivo.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

429

Límite de peticiones excedido; Retry-After indica cuántos segundos esperar. Códigos: limite_excedido.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

Headers

Retry-After

integer

Segundos que hay que esperar.