Estos endpoints se utilizan para conectarse al flujo de creación de reuniones de HubSpot y agregar información de videoconferencias.
hapikey
de consulta al final de la URL de la solicitud. Puedes encontrar la clave de la API de desarrollador en tu cuenta de desarrollador.
PUT
a /crm/v3/extensions/videoconferencing/settings/{appId}?hapikey=YOUR_HUBSPOT_DEVELOPER_API_KEY
.
En el cuerpo de la solicitud, deberás incluir el campo createMeetingUrl
para definir la URL que HubSpot enviará a las cargas útiles de creación de reuniones del webhook. Opcionalmente, puedes incluir URLs de webhooks adicionales. Estos valores pueden actualizarse posteriormente usando la misma URL de solicitud.
Campo | Tipo | Descripción |
---|---|---|
createMeetingUrl | Cadena | La URL que HubSpot notificará cuando se cree una nueva reunión. Esta incluirá una carga útil JSON con los detalles de la reunión. La URL debe usar el protocolo https . |
updateMeetingUrl | Cadena | La URL que HubSpot notificará cuando se actualice una reunión existente. Esta acción incluirá una carga útil JSON con los detalles actualizados de la reunión. La URL debe usar el protocolo https . |
deleteMeetingUrl | Cadena | La URL que HubSpot notificará cuando se elimine una reunión existente. Incluirá un conferenceId de las reuniones eliminadas. La URL debe usar el protocolo https . |
userVerifyUrl | Cadena | La URL que HubSpot utilizará para verificar que un usuario está en el sistema externo de videoconferencia. |
GET
a /crm/v3/extensions/videoconferencing/settings/{appId}
.
La respuesta incluirá las URL de webhooks configuradas en ese momento.
createMeetingUrl
. La carga útil de la solicitud incluye información sobre la cuenta de HubSpot, el usuario asociado de HubSpot y los detalles de la reunión.
Campo | Tipo | Descripción |
---|---|---|
portalId | Número | El ID de la cuenta de HubSpot de la que proviene la solicitud. |
userId | Número | El ID del usuario de HubSpot asignado a la reunión. |
userEmail | Cadena | La dirección de correo electrónico del usuario de HubSpot asignado a la reunión. |
topic | Cadena | El título de la reunión. |
source | Cadena | Indica dónde se creó la reunión. Puede ser cualquiera de las siguientes opciones:
|
startTime | Número | La hora de inicio de la reunión. en milisegundos epoch. |
endTime | Número | La hora de finalización de la reunión, en milisegundos epoch. |
conferenceId
: un ID único asociado con la conferencia en este evento.
Este ID debe ser globalmente único dentro de tu sistema. HubSpot devolverá este ID en el webhook de actualización.
conferenceUrl:
la URL que los usuarios pueden utilizar para unirse a la conferencia.
conferenceDetails
: invitación en texto sin formato. Debe describir cómo los asistentes pueden acceder a la videoconferencia de este evento. Las nuevas líneas se mantendrán en las representaciones de este texto, pero no puede usarse ningún otro formato.
updateMeetingUrl
, HubSpot enviará esta URI a una solicitud cuando se hayan modificado detalles relevantes de una reunión. Esta notificación es necesaria si necesitas mantener siempre al día el tema o los horarios de una videoconferencia. La carga útil de la solicitud incluye información sobre la cuenta de HubSpot, el usuario asociado de HubSpot y los detalles de la reunión.
Campo | Tipo | Descripción |
---|---|---|
conferenceId | Cadena | El identificador único de la conferencia, proporcionado por la integración en la respuesta al webhook de creación de la reunión. |
userId | Número | El ID del usuario de HubSpot asignado a la reunión. Siempre será el mismo usuario que el de la carga útil de la creación de la reunión. |
userEmail | Cadena | La dirección de correo electrónico del usuario de HubSpot asignado a la reunión. Siempre será el mismo usuario que el de la carga útil de la creación de la reunión. |
portalId | Número | El ID de la cuenta de HubSpot de la que proviene la solicitud. |
topic | Cadena | El título de la reunión. |
startTime | Número | La hora de inicio de la reunión, en milisegundos epoch. |
endTime | Número | La hora de finalización de la reunión, en milisegundos epoch. |
200
o 204
para indicar a HubSpot que este webhook se recibió correctamente.
deleteMeetingUrl
. La carga incluirá el conferenceId
de la reunión eliminada.
200
o 204
para indicar a HubSpot que este webhook se recibió correctamente.
userVerifyUrl
. Si esa URL ha sido definida, HubSpot la llamará para obtener tu identificador de usuario nativo. Luego enviará ese identificador como la dirección de correo electrónico del usuario en la llamada subsiguiente. Si no configuras esta URL, HubSpot asumirá siempre que la identidad del usuario está verificada.
Este ajuste es opcional y tú debes determinar si es necesario. Si necesitas mantener un mapeo de usuarios dentro de tu sistema, quizá lo mejor sea asociar el ID del usuario de HubSpot o su correo electrónico a tu ID de usuario interno en cada llamada.
La carga útil de este webhook contiene el ID de la cuenta de HubSpot y la dirección de correo electrónico del usuario.
200
o cualquier código de error (por ejemplo, 404
sería un código adecuado). Si devuelves una respuesta 200
, debes devolver una carga que contenga la nueva identificación que debemos usar en lugar de la dirección de correo electrónico: