Sunbird UCI
  • Overview of Sunbird UCI
  • 📙Learn
    • UCI use cases
    • UCI for Education(Case study)
    • Tech Overview
      • Glossary
      • High-level Architecture Design
      • Design Principles
      • Standards
  • 🚀Use
    • Choose your Persona
    • Adopter - Install and use UCI
      • Pre-requisites, Installation Setup, Post Setup
      • Setting up your very first conversation
      • API Documentation
      • Data Exhaust and Analytics
      • Posthog Event
      • Whatsapp (Netcore)
      • Environment Variables
    • Developer - Contribute to UCI
      • UCI Basics
        • XMessage Specification
        • Transformers
          • ODK Transformer
            • Interactive-Messages
            • Media Messages
            • Location
          • Broadcast Transformer
        • Adapters
          • Firebase Notification Adapter
        • User Segment
        • Schema Overview
          • UCI Core Schema
            • XMessage Schema
            • Assessment DB Schema
          • UCI API Schema
      • Development environment
        • Backend Setup
        • Setting up IDE
        • Environment variable setup
        • Debug services
        • Build and Execute UCI
        • Frontend Setup (Admin Console)
        • Frontend Setup (PWA)
        • Transport Socket
      • API Documentation
        • Bot Setup APIs
        • History APIs
        • Direct Message APIs
        • Vault APIs
      • Database Schema
        • Cassandra Xmessage Database
        • Postgres Forms Database
        • Postgres User Analytics Database
        • Postgres Comms Database
      • Contribution Guide
        • Your first PR
        • Contribute an Adapter
        • Adapter Implementation
        • Create a Transformer
    • Contact the administrator
  • ✅Releases
    • Release V2
  • 🤝Engage
    • Software License
    • Acceptable Use Policy
    • Terms of Service
    • Source Code
    • Discussion Forum
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Use
  2. Adopter - Install and use UCI

API Documentation

PreviousSetting up your very first conversationNextData Exhaust and Analytics

Last updated 1 year ago

Was this helpful?

I want to use UCI for my own use case how do I proceed?

  1. Setup UCI on your infra -

  2. Is the channel and provider you want to use is already supported in UCI?

    1. If yes -> Follow to add your adapter along with your own credentials for the platform

    2. If No -> Follow to contribute a new adapter and then follow the step above

  3. Follow these steps to

In my use case, I want to send direct notifications to the users, I do not want to create a complete conversation flow. How Can I achieve this?

  1. Setup UCI on your infra -

  2. Is the channel and provider you want to use is already supported in UCI?

    1. If yes -> Follow to add your adapter along with your own credentials for the platform

    2. If No -> Follow to contribute a new adapter and then follow the step above

  3. Follow the to send the messages directly

🚀
Steps
create your own bot
Steps
direct Message APIs
these steps
these steps
these steps
these steps