Introducción
El conector de FreshDesk está disponible en el Connectors Xchange de Bizagi.
A través de este conector, podrá conectar sus procesos de Bizagi con los servicios de CRM de FreshDesk en la nube.
Para más información de las capacidades de este conector, visite nuestro Connectors Xchange.
|
Este Conector se desarrolló de acuerdo con los contenidos del API o información sobre los mismos suministrada por FreshDesk. Bizagi no se hace responsable por errores derivados del llamado de los servicios del API, incongruencias en la documentación presentada por FreshDesk. Ni Bizagi ni sus filiales serán responsables de ofrecer cualquier tipo de garantía sobre los contenidos o errores derivados del llamado de los servicios del API. Bizagi y sus filiales no se harán responsables de las pérdidas, los costos o los daños en los que se incurra como consecuencia del acceso o el uso de los servicios del API de FreshDesk. |
Antes de comenzar
Para probar y usar este conector, necesita:
1.Bizagi Studio previamente instalado.
2.Éste conector previamente instalado a traves de Connectors Xchange, tal como se describe en https://help.bizagi.com/platform/es/index.html?Connectors_Xchange.htm, o a través de el manual de instalación descrito en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm
3.Una cuenta en https://developers.freshdesk.com/api/
Cómo obtener la clave API en FreshDesk
Para obtener la clave API de su cuenta de FreshDesk, inicie sesión con su cuenta de FreshDesk, diríjase a la opción de Configuración de Perfil y copie la clave API generada.
Configurar el conector
Para configurar el conector siga los pasos descritos en el capítulo de configuración en https://help.bizagi.com/platform/es/index.html?connectors_setup.htm.
Tenga en cuenta los siguientes parámetros de autenticación:
•Authentication method: Custom
•API_KEY: clave asociada a la cuenta de FreshDesk
•Domain: dominio de la cuenta de FreshDesk
Usar el conector
Este conector permite el uso desde Bizagi de varios métodos disponibles para el uso de los servicios de FreshDesk.
Para configurar el conector, por favor visite el artículo https://help.bizagi.com/platform/es/index.html?Connectors_Studio.htm.
Al usar el conector, tenga en cuenta que puede necesitar configurar entradas o salidas. Las siguientes imágenes muestran ejemplos de cómo mapear las entradas o salidas de un método.
Acciones disponibles
Create a Ticket
Esta acción le permite crear un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•email (Texto - Requerido): correo del contacto que realiza el ticket, si el mail no existe, freshdesk creará uno nuevo con la información del ticket.
•subject (Texto - Requerido): tema del ticket.
•description (Texto - Requerido): descripción del ticket.
•status (Entero) : estado del ticket (open=2, pending=3, resolved=4, closed=5). Si no se especifica ningún estado, el ticket toma el valor, por defecto (2).
•priority (Entero) : prioridad del ticket (low=1, medium=2, high=3, urgent=4) Si no se especifica ninguna prioridad, el ticket toma el valor, por defecto (1).
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id del ticket creado.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#create_ticket.
View a Ticket
Esta acción le permite ver los detalles de un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del ticket a consultar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id del ticket.
•requester_id (Entero): id del contacto creador.
•subject (Texto): asunto del ticket.
•description_text (Texto): descripción del ticket.
•status (Entero): estado del ticket.
•priority (Entero): prioridad del ticket.
•created_at(Texto): fecha de creación.
•responder_id (Entero): id de agente asignado.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#view_a_ticket.
List All Tickets
Esta acción retorna a manera de lista información de tickets permitiendo hacer búsquedas.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•requesterMail (Texto): mail del solicitante.
•companyId (Texto): id de la compañía.
•UpdatedSince (Texto): parametro utilizado para filtrar por fecha de actualización.
•orderBy (Texto): parámetro utilizado para ordernar por: created_at, due_by, updated_at y status.
•orderType (Texto): tipo de ordenamiento: ascendente o descendente.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•output (Colección): listado de tickets con la siguiente información.
oid (Entero): id del ticket.
osubject (Texto): tema del ticket.
otype (Texto): tipo de solicitud.
ocreated_at (Fecha): fecha de creación.
odescription_text (Texto): descripción.
opriority (Entero): prioridad.
ostatus (Entero): estado actual del ticket.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#list_all_tickets.
Filter Tickets
Esta acción le permite filtrar los tickets por estado, prioridad o agente asignado.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•status (Entero): parámetro utilizado para filtrar por estado del ticket.
•priority (Entero): parámetro utilizado para filtrar por prioridad.
•agent_id (Entero): parámetro utilizado para filtrar por agente asignado.
Si no se especifica ningún filtro, por defecto traerá los tickets abiertos.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•total (Entero): total de registros filtrados.
•results (Objeto): resultados de la búsqueda.
oid (Entero): id del ticket.
ostatus (Entero): estado del ticket.
opriority (Entero): prioridad del ticket.
oagent_id (Entero): id del agente asignado al ticket.
orequester_id (Entero): id del contacto creador del ticket.
osubject (Texto): tema del ticket.
odescription_text (Texto): descripción del ticket.
ocreated_at (Fecha): fecha de creación.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#filter_tickets.
Update a Ticket
Esta acción le permite actualizar la información de un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del ticket a actualizar.
•status (Entero): nuevo estado para el ticket.
•priority (Entero): nueva prioridad.
•agentId (Entero): agente asignado al ticket.
•subject (Texto): asunto del ticket.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•statusCode (Texto): código de estado de la petición.
•statusMessage (Texto): mensaje de estado de la petición.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#update_ticket.
Delete a Ticket
Esta acción le permite eliminar un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del ticket a borrar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•statusCode (Texto): código de estado de la petición.
•statusMessage (Texto): mensaje de estado de la petición.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#delete_a_ticket.
Restore a Ticket
Esta acción le permite restaurar un ticket borrado.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del ticket a restaurar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•statusCode (Texto): código de estado de la petición.
•statusMessage (Texto): mensaje de estado de la petición.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#restore_a_ticket.
List All Conversations of a Ticket
Esta acción lista todas las conversaciones de un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del ticket a consultar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•output (Colección): lista con la información de todos los mensajes de un ticket.
obody_text (Texto): cuerpo del mensaje.
ocreated_at (Fecha): fecha de creación.
ofrom_email (Texto): correo electrónico del remitente del mensaje.
oto_emails (Texto): listado de correos electrónicos a quienes se envió el mensaje.
oprivate (boolean): indica si el mensaje es o no privado.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#list_all_ticket_fields.
Create Company
Esta acción le permite crear una compañía.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•name (Texto - Requerido): nombre de la empresa.
•description (Texto): descripción de la empresa.
•renewal_date (Fecha): fecha de renovación (formato AAAA-MM-DD)
•industry (Texto): industria a la que pertenece
•note (Texto): notas adicionales
•domains (Texto): dominios de correo de la empresa separados por comas. Los contactos que tengan correo con los dominios especificados automáticamente serán asociados a la compañía. Para ambientes gratuitos de FreshDesk (versión SPROUT) los campos renewal_date e industry, no están disponibles, por lo tanto si el conector se usa para crear compañías que involucren estos campos, arrojará error.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id resultante de la creación
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#create_company.
Update Company
Esta acción le permite actualizar los datos de una compañía.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id de la compañía a actualizar.
•name (Texto - Requerido): nombre de la empresa.
•description (Texto): descripción de la empresa.
•renewal_date (Fecha): fecha de renovación (formato AAAA-MM-DD).
•industry (Texto): industria a la que pertenece.
•note (Texto): notas adicionales.
•domains (Texto): dominios de correo de la empresa separados por comas. Los contactos que tengan correo con los dominios especificados automáticamente serán asociados a la compañía. Para ambientes gratuitos de FreshDesk (versión SPROUT) los campos renewal_date e industry, no están disponibles, por lo tanto si el conector se usa para crear compañías que involucren estos campos, arrojará error.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•statusCode (Texto): código de estado de la petición.
•statusMessage (Texto): mensaje de estado de la petición.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#update_company.
Delete Company
Esta acción le permite borrar una compañía.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id de la compañía a eliminar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•statusCode (Texto): código de estado de la petición.
•statusMessage (Texto): mensaje de estado de la petición.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#delete_company.
View a Company
Esta acción le permite ver los detalles de una compañía.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id de la compañía a consultar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id de la compañía a actualizar.
•name (Texto): nombre de la empresa.
•description (Texto): descripción de la empresa.
•renewal_date (Fecha): fecha de renovación (formato AAAA-MM-DD).
•industry (Texto): industria a la que pertenece.
•note (Texto): notas adicionales.
•domains (Texto): dominios de correo de la empresa separados por comas.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#view_company.
List All Companies
Esta acción lista todas las compañías disponibles.
Para esta acción no necesita configurar ninguna entrada.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•output (colección): lista de todas las compañías disponibles.
oid (Entero): id de la compañía a actualizar.
oname (Texto): nombre de la empresa.
odescription (Texto): descripción de la empresa.
orenewal_date (Fecha): fecha de renovación (formato AAAA-MM-DD).
oindustry (Texto): industria a la que pertenece.
onote (Texto): notas adicionales.
odomains (Texto): dominios de correo de la empresa separados por comas.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#list_all_companies.
View an Agent
Esta acción le permite ver los detalles de un agente.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del agente a consultar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id del agente
•available (booleano): disponibilidad del agente
•created_at (Fecha): fecha de creación
•contact (Objeto): información de contacto del agente
oemail (Texto): correo electrónico del agente
ojob_title (Texto): cargo del agente
oname (Texto): nombre del agente
ophone (Texto): teléfono del agente
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#view_agent.
List All Agents
Esta acción retorna un listado de los agentes, permite buscar por correo de agente.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•email (Texto): parámetro para filtrar agentes por correo electrónico. Si el correo electrónico ingresado no tiene coincidencias, la acción retornará una lista vacía.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•Output (Colección): lista de todos los agentes que cumplan con el filtro en caso de haberlo definido.
oid (Entero): id del agente
oavailable (Booleano): disponibilidad del agente
ocreated_at (Fecha): fecha de creación
ocontact (Objeto): información de contacto del agente
▪email (Texto): correo electrónico del agente
▪job_title (Texto): cargo del agente
▪name (Texto): nombre del agente
▪phone (Texto): teléfono del agente
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#list_all_agents.
View a Contact
Esta acción le permite ver los detalles de un contacto.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del contacto a consultar.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id del contacto.
•created_at (Fecha): fecha de creación del contacto.
•email (Texto): email del contacto.
•job_title (Texto): cargo del contacto.
•name (Texto): nombre del contacto.
•x_id (Texto): cuenta x del contacto.
•description (Texto): descripción del contacto.
•updated_at (Fecha): fecha de actualización del contacto.
•language (Texto): idioma.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#view_contact.
Update a Contact
Esta acción le permite actualizar la información de un contacto.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•id (Entero - Requerido): id del contacto.
•email (Texto): correo del contacto.
•job_title (Texto): cargo del contacto.
•name (Texto): nombre del contacto.
•description (Texto): descripción del contacto.
•x_id (Entero): cuenta de x del contacto.
•language (Texto): idioma.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•statusCode (Texto): código de estado de la petición.
•statusMessage (Texto): mensaje de estado de la petición.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#update_contact.
List All Contacts
Esta acción lista los contactos, permite bucar por mail.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•email (Texto): parámetro para filtrar contactos por correo
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•Output (Colección): lista de todos los contactos encontrados
oid (Entero): Id del contacto.
oaddress (Texto): Dirección del contacto.
oemail (Texto): Email de contacto.
oactive (Booleano): Indica si está activo o no.
omobile (Texto): Teléfono móvil.
olanguage (Texto): Idioma.
oname (Texto): Nombre del contacto.
ox_id (Entero): Cuenta de x.
ocreated_at (Fecha): Fecha de creación.
ojob_title (Texto): Cargo.
odescription (Texto): Descripción del contacto.
oupdated_at (Fecha): Fecha de actualización.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#list_all_contacts.
Create a Reply
Esta acción crea una respuesta a un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•ticket_id (Entero - Requerido): id del ticket al cual se va a responder.
•body (Texto - Requerido): mensaje de respuesta.
•user_id (Entero): id del agente quien envía la respuesta, sino se define ningún agente, se toma como el usuario que se usó para generar la clave API. El rol del agente debe tener los privilegios para agregar notas a los tickets, además de estar activado.
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id de la respuesta creada.
•body_text (Texto): texto de la respuesta.
•from_email (Texto): correo de quien hizo la respuesta.
•ticket_id (Entero): id del ticket al cual se asoció la respuesta.
•created_at (Fecha): fecha de creación.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#reply_ticket.
Create a Note to a Ticket
Esta acción crea una nota a un ticket.
Para configurar las entradas de esta acción, tenga en cuenta las siguientes descripciones:
•ticket_id (Entero - Requerido): id del ticket al cual se va a crear la nota.
•body (Texto - Requerido): mensaje.
•user_id (Entero): id del agente quien coloca la nota.
•private (booleano): indica si es privada o no (si es privada los clientes no pueden ver esta nota, solo los agentes pueden verla).
Para configurar las salidas de esta acción relacione el objeto output con la entidad correspondiente en Bizagi, vinculando los atributos de esta entidad.
•id (Entero): id de la nota.
•body_text (Texto): texto de la nota.
•ticket_id (Entero): id del ticket al cual se asoció la nota.
•created_at (Fecha): fecha de creación.
Para más información acerca del uso de este método, consulte la documentación oficial de FreshDesk en https://developers.freshdesk.com/api/#add_note_to_a_ticket.
Last Updated 8/2/2024 4:33:15 PM