Webhooks

Nuestros Webhooks te permitiran suscribirte a eventos sobre tus contratos y tener en tiempo real las actualizaciones que se realicen en ellos.

Configuración

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.

Eventos

Un contrato podrá disparar los siguientes eventos:

Evento signed

Este evento se dispará cuando un participante del contrato realice la acción de firma. El cuerpo del evento tendrá la siguiente estructura JSON:

{
  "contractid": "5d5c445d6bb8f43f78c59349",
  "name": "Nombre del contrato",
  "participant": {
    "signedAt": "2019-08-20T22:05:13.531Z",
    "_id": "5d5c444d67026a28a8ae8dd4"
  },
  "event": "signed",
  "externalId": "ID001"
}

Evento signed-all

Este evento se dispará cuando TODOS los participante del contrato hayan firmado el contrato. El cuerpo del evento tendrá la siguiente estructura JSON:

{
  "contractid": "5d5c445d6bb8f43f78c59349",
  "name": "Nombre del contrato",
  "signedAt": "2019-08-20T22:05:39.637Z",
  "event": "signed-all",
  "externalId": "ID001"
}

Evento document-finalized

Este evento se dispará cuando el contrato cambie a estatus finalizado. El cuerpo del evento tendrá la siguiente estructura JSON:

{
  "contractid": "5d5c445d6bb8f43f78c59349",
  "name": "Nombre del contrato",
  "finalizedAt": "2019-08-20T22:05:39.637Z",
  "event": "document-finalized",
  "externalId": "ID001"
}

Evento document-removed

Este evento se dispará cuando el contrato sea eliminado. El cuerpo del evento tendrá la siguiente estructura JSON:

{
  "contractid": "5d5c445d6bb8f43f78c59349",
  "name": "Nombre del contrato",
  "deletedAt": "2019-08-20T22:05:39.637Z",
  "event": "document-removed",
  "externalId": "ID001"
}

Evento milestone-completed

Este evento se dispará cuando un hito del contrato cambie a estatus completado. El cuerpo del evento tendrá la siguiente estructura JSON:


      {
        "contractid": "5d5c445d6bb8f43f78c59349",
        "name": "Nombre del contrato",
        "milestoneId: "5c4c243d6db7f23f71c29343",
        "event": "milestone-completed",
        "externalId": "ID001"
      }

Evento all-milestones-completed

Este evento se dispará cuando todos los hitos del contrato esten completados. El cuerpo del evento tendrá la siguiente estructura JSON:

{
  "contractid": "5d5c445d6bb8f43f78c59349",
  "name": "Nombre del contrato",
  "event": "all-milestones-completed",
  "externalId": "ID001"
}