Skip to content

Wipsy CRM API (1.1.0)

🚀 Prueba con Datos Reales

Para que esta documentación devuelva datos de tu cuenta en lugar de ejemplos ficticios:

  1. Ve a tu panel de Wipsy y obtén tu API Key.
  2. En el panel derecho de "Try it", haz clic en el botón de Authentication.
  3. Pega tu clave en el campo x-api-key.
  4. Asegúrate de tener seleccionado el Production server en el selector de servidores.

Características principales:

  • Mensajería multicanal (WhatsApp, Instagram, Facebook Messenger)
  • Gestión de Pipeline y embudos de venta
  • Sistema de etiquetas y campos personalizados
  • Soporte para mensajes citados y estados de entrega (enviado, entregado, leído)
  • Autenticación de agentes y permisos segmentados
Download OpenAPI description
openapi.json
openapi.yaml
Overview
Wipsy Support
support@wipsy.com
License
Proprietary
Languages
Servers
Production server
https://api.getwipsy.com/functions/v1/

Messages

Send and manage messages across different channels

Operations

Chats

Retrieve and manage chat conversations

Operations

Contacts

Manage customer contacts

Operations

Agents

Agent authentication and data access

Operations

Get chats for agent

Request

Retrieve chat conversations for an authenticated agent. Requires agent session authentication.

Security
BearerAuth
Bodyapplication/jsonrequired
agentSessionobject(AgentSession)required
agentSession.​agentobjectrequired
agentSession.​agent.​idstring
agentSession.​agent.​namestring
agentSession.​agent.​emailstring
agentSession.​agent.​rolestring
agentSession.​agent.​owner_user_idstring
agentSession.​agent.​organization_idstring or null
agentSession.​permissionsobject
agentSession.​sessionobjectrequired
agentSession.​session.​tokenstring
agentSession.​session.​expires_atstring(date-time)
statusstring
Default "all"
Enum"all""active""pending""completed"
curl -i -X POST \
  https://api.getwipsy.com/functions/v1/agent-get-chats \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentSession": {
      "agent": {
        "id": "string",
        "name": "string",
        "email": "string",
        "role": "string",
        "owner_user_id": "string",
        "organization_id": "string"
      },
      "permissions": {
        "property1": true,
        "property2": true
      },
      "session": {
        "token": "string",
        "expires_at": "2019-08-24T14:15:22Z"
      }
    },
    "status": "all"
  }'

Responses

Chats retrieved successfully

Bodyapplication/json
chatsArray of objects(Chat)
Response
application/json
{
  "chats": [
    { … }
  ]
}

Get messages for a chat (agent)

Request

Retrieve messages for a specific chat conversation. Requires agent session authentication.

Security
BearerAuth
Bodyapplication/jsonrequired
agentSessionobject(AgentSession)required
agentSession.​agentobjectrequired
agentSession.​agent.​idstring
agentSession.​agent.​namestring
agentSession.​agent.​emailstring
agentSession.​agent.​rolestring
agentSession.​agent.​owner_user_idstring
agentSession.​agent.​organization_idstring or null
agentSession.​permissionsobject
agentSession.​sessionobjectrequired
agentSession.​session.​tokenstring
agentSession.​session.​expires_atstring(date-time)
chatIdstring(uuid)required
limitinteger[ 1 .. 100 ]
Default 50
curl -i -X POST \
  https://api.getwipsy.com/functions/v1/agent-get-messages \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "agentSession": {
      "agent": {
        "id": "string",
        "name": "string",
        "email": "string",
        "role": "string",
        "owner_user_id": "string",
        "organization_id": "string"
      },
      "permissions": {
        "property1": true,
        "property2": true
      },
      "session": {
        "token": "string",
        "expires_at": "2019-08-24T14:15:22Z"
      }
    },
    "chatId": "f255124e-3419-4f6e-b7ee-17a6577db94d",
    "limit": 50
  }'

Responses

Messages retrieved successfully

Bodyapplication/json
messagesArray of objects(Message)
Response
application/json
{
  "messages": [
    { … }
  ]
}

Inventory

Product inventory management

Operations

Pipeline

Manage pipeline stages for contacts

Operations

Tags

Manage tags for contacts and chats

Operations

CustomFields

Manage custom fields for contacts

Operations