Papercups

aid: papercups
url: https://raw.githubusercontent.com/api-evangelist/papercups/refs/heads/main/apis.yml
name: Papercups
kind: company
description: Papercups is an open-source customer-messaging and live-chat platform built on Elixir/Phoenix, positioned as
  a self-hosted alternative to Intercom. It exposes a REST API for conversations, messages, and customers, a realtime chat
  surface over Phoenix WebSocket channels, and outbound webhooks. The project is in maintenance mode (community-maintained,
  no major new features).
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/papercups.png
tags:
- Customer Messaging
- Live Chat
- Open Source
- Support
- Intercom Alternative
created: '2026-06-20'
modified: '2026-06-20'
specificationVersion: '0.19'
apis:
- aid: papercups:notifications
  name: Papercups Notifications & Webhooks API
  tags:
  - Webhooks
  - Notifications
  - Events
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://docs.papercups.io/webhook-events
  baseURL: https://app.papercups.io/api/v1
  properties:
  - url: https://docs.papercups.io/webhook-events
    type: Documentation
  - url: https://github.com/papercups-io/papercups/wiki/Event-Subscriptions-with-Webhooks
    type: APIReference
  - url: https://github.com/papercups-io/papercups
    type: GitHub
  description: Outbound event subscriptions delivered as webhooks (message:created, conversation:created, conversation:updated,
    and a webhook:verify challenge handshake) notifying external systems of activity.
- aid: papercups:realtime-chat
  name: Papercups Realtime Chat API (WebSocket / Phoenix Channels)
  tags:
  - Realtime
  - WebSocket
  - Phoenix Channels
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://docs.papercups.io/chat
  baseURL: wss://app.papercups.io/socket/websocket
  properties:
  - url: https://docs.papercups.io/chat
    type: Documentation
  - url: asyncapi/papercups-asyncapi.yml
    type: AsyncAPI
  - url: https://github.com/papercups-io/papercups
    type: GitHub
  description: Bidirectional realtime live chat over Phoenix WebSocket channels. Clients join conversation, conversation-lobby,
    and account-room channels and exchange shout (message), messages:seen, and presence events for two-way messaging.
- aid: papercups:webhooks
  name: Papercups Webhooks
  tags:
  - Webhooks
  - Events
  - Integrations
  image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
  humanURL: https://github.com/papercups-io/papercups/wiki/Event-Subscriptions-with-Webhooks
  baseURL: https://app.papercups.io/api/v1
  properties:
  - url: https://docs.papercups.io/webhook-events
    type: Documentation
  - url: https://github.com/papercups-io/papercups/wiki/Event-Subscriptions-with-Webhooks
    type: APIReference
  - url: https://github.com/papercups-io/webhooks-demo
    type: GitHub
  description: Register external HTTPS endpoints to receive Papercups events as POSTed JSON payloads of shape { event, payload
    }, with a verify-challenge handshake on registration.
- aid: papercups:papercups-conversations-api
  name: Papercups Conversations API
  description: Threads of messages between customers and agents.
  humanURL: https://docs.papercups.io/api-endpoints
  baseURL: https://app.papercups.io/api/v1
  tags:
  - Conversations
  properties:
  - type: OpenAPI
    url: openapi/papercups-conversations-api-openapi.yml
  - type: Documentation
    url: https://docs.papercups.io/api-endpoints
  - type: APIReference
    url: https://docs.papercups.io/api-endpoints
  - type: GitHub
    url: https://github.com/papercups-io/papercups
- aid: papercups:papercups-customers-api
  name: Papercups Customers API
  description: Customer records (users, leads, or contacts).
  humanURL: https://docs.papercups.io/api-endpoints
  baseURL: https://app.papercups.io/api/v1
  tags:
  - Customers
  properties:
  - type: OpenAPI
    url: openapi/papercups-customers-api-openapi.yml
  - type: Documentation
    url: https://docs.papercups.io/api-endpoints
  - type: APIReference
    url: https://docs.papercups.io/api-endpoints
  - type: GitHub
    url: https://github.com/papercups-io/papercups
- aid: papercups:papercups-messages-api
  name: Papercups Messages API
  description: Individual messages within conversations.
  humanURL: https://docs.papercups.io/api-endpoints
  baseURL: https://app.papercups.io/api/v1
  tags:
  - Messages
  properties:
  - type: OpenAPI
    url: openapi/papercups-messages-api-openapi.yml
  - type: Documentation
    url: https://docs.papercups.io/api-endpoints
  - type: APIReference
    url: https://docs.papercups.io/api-endpoints
  - type: GitHub
    url: https://github.com/papercups-io/papercups
- aid: papercups:papercups-users-api
  name: Papercups Users API
  description: Authenticated user and team members.
  humanURL: https://docs.papercups.io/api-endpoints
  baseURL: https://app.papercups.io/api/v1
  tags:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/papercups-users-api-openapi.yml
  - type: Documentation
    url: https://docs.papercups.io/api-endpoints
  - type: APIReference
    url: https://docs.papercups.io/api-endpoints
  - type: GitHub
    url: https://github.com/papercups-io/papercups
common:
- type: AgenticAccess
  url: agentic-access/papercups-agentic-access.yml
- type: DomainSecurity
  url: security/papercups-domain-security.yml
- type: Authentication
  url: authentication/papercups-authentication.yml
- type: GitHubOrganization
  url: https://github.com/papercups-io
- type: LinkedIn
  url: https://www.linkedin.com/company/papercups
- type: Website
  url: https://papercups.io
- type: Documentation
  url: https://docs.papercups.io
- type: Plans
  url: plans/papercups-plans-pricing.yml
- type: RateLimits
  url: rate-limits/papercups-rate-limits.yml
- type: FinOps
  url: finops/papercups-finops.yml
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com