Escuche eventos de Portant mediante webhooks

Haga que Portant envíe eventos POST a su propio servidor cuando se ejecute una automatización. Añada el bloque Send Webhook Events (Enviar eventos de Webhook) a su flujo de trabajo y Portant enviará una solicitud por cada elemento de origen procesado.

Los eventos se envían por elemento de origen. Un elemento de origen es una unidad individual de datos de origen (por ejemplo, una fila en Google Sheets). Si una automatización se ejecuta sobre varios elementos de origen, Portant envía un webhook por elemento.

Esquema del payload

Todos los eventos que envía Portant comparten la misma estructura de nivel superior. El contenido de data varía según event_type.

Campo	Descripción
event_id	Un identificador único generado para este evento.
event_type	El tipo de evento. Determina qué contiene data (consulte los tipos de eventos a continuación).
data	El payload del evento. El esquema varía según event_type.

Ejemplo de esquema

{
  "data": {
    ... // Determined by the type of event
  },
  "event_id": "325d36e717d9ec0943a55857ae2d4988ce33fe4165330e4f",
  "event_type": "<EVENT_TYPE>"
}

Tipos de eventos

Portant envía actualmente cuatro tipos de eventos. Los que usted recibe dependen de su flujo de trabajo: por ejemplo, solo recibirá EMAILS_CREATED si su flujo de trabajo incluye un bloque de correo electrónico.

Documentos creados

La automatización creó nuevos documentos (Google Docs, Google Slides o PDFs).

Configuración del flujo de trabajo

El flujo de trabajo debe contener un bloque de plantilla (Google Docs o Google Slides).

Esquema

Campo	Descripción
documents	Un array con todos los documentos creados para este elemento de origen.
documents.id	El ID de Google Drive del archivo.
documents.url	La URL de Google Drive del archivo.
documents.name	El nombre del archivo tal como aparece en Google Drive.
documents.mimetype	El tipo MIME del archivo (véase a continuación).

Tipos MIME

Mimetype	Descripción
application/vnd.google-apps.document	Archivo de Google Docs
application/vnd.google-apps.presentation	Archivo de Google Slides
application/pdf	Documento PDF

Ejemplo de payload

{
  "data": {
    "documents": [
      {
        "id": "12XXXXX..................",
        "url": "https://docs.google.com/document/d/12XXXXX................../edit?usp=drivesdk",
        "name": "Invoice #1200",
        "mimetype": "application/vnd.google-apps.document"
      },
      {
        "id": "13XXXXX..................",
        "url": "https://drive.google.com/file/d/13XXXXX................../view?usp=drivesdk",
        "name": "Invoice #1200",
        "mimetype": "application/pdf"
      }
    ]
  },
  "event_id": "325d36e717d9ec0943a55857ae2d4988ce33fe4165330e4f",
  "event_type": "DOCUMENTS_CREATED"
}

Correos electrónicos creados

La automatización creó y envió correos electrónicos. Este evento no se activa para solicitudes de firma.

Configuración del flujo de trabajo

El flujo de trabajo debe contener un bloque de correo electrónico (Gmail).

Esquema

Campo	Descripción
emails	Un array con todos los correos electrónicos creados para este elemento de origen.
emails.message_id	El ID del mensaje en Gmail.
emails.to	Una cadena de direcciones de destinatarios separadas por comas.
emails.subject	El asunto del correo electrónico.

Ejemplo de payload

{
  "data": {
    "emails": [
      {
        "to": "contact@portant.co",
        "subject": "Hello World",
        "message_id": "18xxxx........."
      }
    ]
  },
  "event_id": "eac17961e3edcfafcc064015131e8a518c9f375005b8cec2",
  "event_type": "EMAILS_CREATED"
}

Firmas solicitadas

La automatización envió solicitudes de firma.

Configuración del flujo de trabajo

El flujo de trabajo debe contener un bloque de solicitud de firma.

Esquema

Campo	Descripción
documents	Un array de documentos creados para este elemento fuente. Tiene la misma estructura que el evento Documents created.
recipients	Un array de destinatarios de solicitudes de firma en el flujo de trabajo.
recipients.email	El correo electrónico del destinatario.
recipients.order	El orden en que este destinatario firma.
recipients.status	El estado actual. Siempre "PENDING" para este evento.
recipients.signature_url	La URL del portal de firmas donde el destinatario puede completar la solicitud.

Ejemplo de payload

{
  "data": {
    "documents": [
      {
        "id": "10XXXXX.................",
        "url": "https://drive.google.com/file/d/10XXXXX................./view?usp=drivesdk",
        "name": "Employment Contact",
        "mimetype": "application/pdf"
      }
    ],
    "recipients": [
      {
        "email": "bwlockley@gmail.com",
        "order": 1,
        "status": "PENDING",
        "signature_url": "https://sign.portant.co/xxxxxxxxxxxxx"
      }
    ]
  },
  "event_id": "66de24a8c20fa439d47d92a683861f6852c2924632623377",
  "event_type": "SIGNATURES_REQUESTED"
}

Signatures completed

Todas las solicitudes de firma del proceso de automatización han sido completadas.

Configuración del flujo de trabajo

El flujo de trabajo debe contener un bloque de solicitud de firma.

Esquema

Igual que el evento Signatures requested. El campo recipients.status tiene el valor "COMPLETED" para cada destinatario.

Ejemplo de payload

{
  "data": {
    "documents": [
      {
        "id": "10XXXXX.................",
        "url": "https://drive.google.com/file/d/10XXXXX......../view?usp=drivesdk",
        "name": "Employment Contact",
        "mimetype": "application/pdf"
      }
    ],
    "recipients": [
      {
        "email": "bwlockley@gmail.com",
        "order": 1,
        "status": "COMPLETED",
        "signatureUrl": "https://sign.portant.co/xxxxxxxxxxxxx"
      }
    ]
  },
  "event_id": "72c32ca744baea46b4be710f052b14a9b73a29d77076e586",
  "event_type": "SIGNATURES_COMPLETED"
}