Webhooks
Nuestros Webhooks te permitiran suscribirte a eventos sobre tus contratos y tener en tiempo real las actualizaciones que se realicen en ellos.
Configuracion
Nuestros Webhooks constan de una llamada tipo POST en formato JSON, que realizaremos a la liga o ligas que configures en tu perfil y en base a los eventos a los que te suscribas en cada una de ellas. La liga debe usar https.
Eventos
Un contrato podra disparar los siguientes eventos:
Evento signed
Este evento se disparara cuando un participante del contrato realice la accion de firma. El cuerpo del evento tendra la siguiente estructura JSON:
{
"contractid": "5d5c445d6bb8f43f78c59349",
"name": "Contract name",
"participant": {
"signedAt": "2019-08-20T22:05:13.531Z",
"_id": "5d5c444d67026a28a8ae8dd4"
},
"event": "signed",
"externalId": "ID001"
}
Evento signed-all
Este evento se disparara cuando TODOS los participantes del contrato hayan firmado el contrato. El cuerpo del evento tendra la siguiente estructura JSON:
{
"contractid": "5d5c445d6bb8f43f78c59349",
"name": "Contract name",
"signedAt": "2019-08-20T22:05:39.637Z",
"event": "signed-all",
"externalId": "ID001"
}
Evento document-finalized
Este evento se disparara cuando el contrato cambie a estatus finalizado. El cuerpo del evento tendra la siguiente estructura JSON:
{
"contractid": "5d5c445d6bb8f43f78c59349",
"name": "Contract name",
"finalizedAt": "2019-08-20T22:05:39.637Z",
"event": "document-finalized",
"externalId": "ID001"
}
Evento document-removed
Este evento se disparara cuando el contrato sea eliminado. El cuerpo del evento tendra la siguiente estructura JSON:
{
"contractid": "5d5c445d6bb8f43f78c59349",
"name": "Contract name",
"deletedAt": "2019-08-20T22:05:39.637Z",
"event": "document-removed",
"externalId": "ID001"
}
Evento milestone-completed
Este evento se disparara cuando un hito del contrato cambie a estatus completado. El cuerpo del evento tendra la siguiente estructura JSON:
{
"contractid": "5d5c445d6bb8f43f78c59349",
"name": "Contract name",
"milestoneId": "5c4c243d6db7f23f71c29343",
"event": "milestone-completed",
"externalId": "ID001"
}
Evento all-milestones-completed
Este evento se disparara cuando todos los hitos del contrato esten completados. El cuerpo del evento tendra la siguiente estructura JSON:
{
"contractid": "5d5c445d6bb8f43f78c59349",
"name": "Contract name",
"event": "all-milestones-completed",
"externalId": "ID001"
}
Encabezado secreto
Es posible configurar un encabezado secreto para identificar que la llamada provenga de TRATO; dicho encabezado contendra la cadena secreta proporcionada por TRATO en el header: X-Trato-Secret.
Consideraciones
Ten en cuenta que es posible que en el futuro se agreguen nuevas propiedades a los cuerpos de los eventos, por lo cual realiza tu desarrollo de manera que recibir una nueva propiedad no afecte tu implementacion.
Soporte
Tienes alguna duda tecnica sobre la documentacion o implementacion de nuestros webhooks? Envia un correo a [TRATO Dev Team](mailto:soporte@trato.io) y con gusto te apoyaremos.