Diferencia entre revisiones de «API LaFactura.co:Webhook»
Ir a la navegación
Ir a la búsqueda
Línea 29: | Línea 29: | ||
*El evento informa que cambió el estado del documento (change: true) | *El evento informa que cambió el estado del documento (change: true) | ||
*El nuevo estado del documento es 2 (Aprobado por la DIAN) | *El nuevo estado del documento es 2 (Aprobado por la DIAN) | ||
+ | |||
+ | |||
====Ejemplo 2==== | ====Ejemplo 2==== | ||
Línea 56: | Línea 58: | ||
*El evento informa que NO cambió el estado del documento | *El evento informa que NO cambió el estado del documento | ||
*El correo fué recibido efectivamente por el buzon | *El correo fué recibido efectivamente por el buzon | ||
+ | |||
=====Campos===== | =====Campos===== | ||
+ | ---- | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
Línea 73: | Línea 77: | ||
|- | |- | ||
| process->newValue || El nuevo estado del documento (Solo si change=true)<br/><small>Estado de proceso 0 -> Enviando / 1 -> Verificando / 2 -> Aceptado DIAN // Mayor que 90 -> Rechazado DIAN</small> || numerico || SI/NO | | process->newValue || El nuevo estado del documento (Solo si change=true)<br/><small>Estado de proceso 0 -> Enviando / 1 -> Verificando / 2 -> Aceptado DIAN // Mayor que 90 -> Rechazado DIAN</small> || numerico || SI/NO | ||
+ | |- | ||
+ | | email|| información de correo || cadena || NO | ||
+ | |- | ||
+ | | email->email || correo electronico del evento || cadena || SI<br/><small>Solo si el evento es relacionado con correos</small> | ||
+ | |- | ||
+ | | email->accepted || aceptacion del correo poe el buzon || boolean || SI<br/><small>Solo si el evento es relacionado con correos</small> | ||
|} | |} |
Revisión del 12:57 19 ene 2021
Sumario
Webhook
Por nuestro sistema de interconexión, podemos enviarte a una URL tuya, una respuesta de tipo automática cada vez que suceda un cambio de estado o un evento en tus documentos.
IMPORTANTE: Para recibir estas notificaciones, debes enviarnos por correo la url específica a la cual quieras que te enviemos los eventos. (La url debe en todo caso ser https)
Objeto:event
El objeto event lleva el resultado del evento ocurrido
Ejemplo 1
{ "event":{ "tascode":"fc-ioeri98499843yuyw97397329382", "date":"20210125102005", "text":"Documento aprobado por la DIAN", "process":{ "change":true, "newValue":2 } } }
Explicacion
Se recibió un evento:
- Documento relacionado: fc-ioeri98499843yuyw97397329382
- Fecha del evento: 2021-01-25 10:20:05
- Texto del evento: Documento aprobado por la DIAN
- El evento informa que cambió el estado del documento (change: true)
- El nuevo estado del documento es 2 (Aprobado por la DIAN)
Ejemplo 2
{ "event":{ "tascode":"fc-ioeri98499843yuyw97397329382", "date":"20210125102005", "text":"El correo fué recibido por el buzón de [email protected]", "process":{ "change":false }, "email":{ "email":"[email protected]", "accepted":true } } }
Explicacion
Se recibió un evento:
- Documento relacionado: fc-ioeri98499843yuyw97397329382
- Fecha del evento: 2021-01-25 10:20:05
- Texto del evento: El correo fué recibido por el buzón de [email protected]
- El evento informa que NO cambió el estado del documento
- El correo fué recibido efectivamente por el buzon
Campos
Parámetro | Descripción | Tipo | Obligatorio |
---|---|---|---|
tascode | Identificador único, del documento del evento | cadena | SI |
date | Fecha del evento (YYYYMMDDHHMMSS) Ejemplo: 20210125102005 |
cadena | SI |
text | Información del evento en texto | cadena | SI |
process | Información del proceso | objeto | SI |
process->change | Si cambió el estado del documento (true/false) | boolean | SI |
process->newValue | El nuevo estado del documento (Solo si change=true) Estado de proceso 0 -> Enviando / 1 -> Verificando / 2 -> Aceptado DIAN // Mayor que 90 -> Rechazado DIAN |
numerico | SI/NO |
información de correo | cadena | NO | |
email->email | correo electronico del evento | cadena | SI Solo si el evento es relacionado con correos |
email->accepted | aceptacion del correo poe el buzon | boolean | SI Solo si el evento es relacionado con correos |