Diferencia entre revisiones de «API LaFactura.co:Webhook»
Ir a la navegación
Ir a la búsqueda
(→Campos) |
(→Campos) |
||
| Línea 72: | Línea 72: | ||
| process->change || Si cambió el estado del documento (true/false) || boolean || SI | | process->change || Si cambió el estado del documento (true/false) || boolean || SI | ||
|- | |- | ||
| − | | process->newValue || El nuevo estado del documento (Solo si change=true)<br/><small>Estado de proceso 0 -> | + | | process->newValue || El nuevo estado del documento (Solo si change=true)<br/><small>Estado de proceso:<br/>0 -> En cola <br/>1 -> En proceso DIAN / 2 -> Aceptado DIAN / Mayor que 90 -> Rechazado DIAN</small> || numerico || SI/NO |
|- | |- | ||
| email|| información de correo || cadena || NO | | email|| información de correo || cadena || NO | ||
Revisión del 17:11 23 abr 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",
"intID":"212121"
"date":"20210125102005",
"text":"Documento aprobado por la DIAN",
"process":{
"change":true,
"newValue":2
}
}
}
Explicacion
Se recibió un evento:
- Documento relacionado: fc-ioeri98499843yuyw97397329382
- El ID en tu sistema es 212121
- 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]",
"email":{
"email":"[email protected]",
"status":2
}
}
}
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 correo fué recibido efectivamente por el buzon status = (2)
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 Solo aparece cuando se trata de un cambio de estado del documento |
objeto | NO |
| 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 -> En cola 1 -> En proceso DIAN / 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->status | Estado de transporte del correo | numerico | SI Solo si el evento es relacionado con correos |