Foccuz Integration API
  1. API externa
Foccuz Integration API
  • API externa
    • Comenzando con Foccuz Integration API
    • Autenticación vía API Key
    • Límite de uso (Rate Limiting) y Restricciones de tamaño (Body Size Limiting)
    • Colaboradores con Compensaciones Variables (Usuario/Colaborador)
    • Empresas (Clientes/Cuentas/Compañías)
    • Negocio (Operación, Venta, Cobranza, Acción clave)
    • Actividad (Acción, Productividad, Indicador)
    • Campos personalizados
    • Orden de ejecucción
    • Consideraciones
    • Flujos de ejemplo
    • Manejo de errores
    • v2
      • integration
        • deals
          • /v2/integration/deals
          • /v2/integration/deals
        • activities
          • /v2/integration/activities
          • /v2/integration/activities
        • account
          • /v2/integration/account
          • /v2/integration/account
        • sales-profile
          • /v2/integration/sales-profile
          • /v2/integration/sales-profile
  • Integraciones
    • Buk
      • Conectarse con Buk
  1. API externa

Actividad (Acción, Productividad, Indicador)

Nombre de la entidad: Activity
Descripción: Representa una actividad o acción que puede ser medible por parte de un colaborador, que puede impactar la productividad, desempeño y puede ser considerado para ser evaluados a nivel de compensaciones variables.
Endpoint: POST /v2/integration/activities

Propiedades Requeridas:#

externalId (string): Identificador único en el sistema externo
type (enum): Tipo de actividad
CALL: Llamada
MEET: Reunión
DEMO: Demostración
EMAIL: Email
OPPORTUNITY: Oportunidad
ownerExternalId (string): ID externo del propietario (debe existir como Sales Profile)

Propiedades Opcionales:#

source (object): Fuente de la actividad
associated (object): Entidades asociadas
accountExternalId (string): ID externo de la cuenta
dealExternalId (string): ID externo del deal
customFields (array): Campos personalizados

Ejemplo de Request:#

{
  "batchId": "batch-004",
  "source": "external-crm",
  "items": [
    {
      "externalId": "ACT-001",
      "type": "CALL",
      "ownerExternalId": "USER-001",
      "associated": {
        "accountExternalId": "ACC-001",
        "dealExternalId": "DEAL-001"
      },
      "customFields": [
        {
          "key": "duration",
          "type": string,
          "value": "30",
          "name": "custom_field_1"
        }
      ]
    }
  ]
}
Modificado en 2025-10-10 13:44:05
Anterior
Negocio (Operación, Venta, Cobranza, Acción clave)
Siguiente
Campos personalizados
Built with