Connectivity platform migration guide

Overview

Introduction to the Migration Guide

This guide is designed to help you transition from the Connectivity Platform’s Conversations API to Bird CRM seamlessly. It highlights the key differences, benefits, and step-by-step instructions for migrating your workflows to take full advantage of Bird CRM’s improved features.

Whether you’re managing messaging channels, synchronizing templates, or handling conversations programmatically, this guide ensures a smooth migration experience tailored to your business needs.

Key sections in this guide

To help you navigate quickly, here are the key topics covered:

Choosing between Channels API and Conversations API

Learn when and how to use these APIs effectively.

Migrating conversations API actions

Step-by-step instructions for updating your messaging workflows.

Migrating WhatsApp channels

A guide to transferring your WhatsApp configurations to the new platform.

Key APIs in the New Platform

Bird CRM offers two primary APIs for managing your messaging workflows:

1. Channels API: For direct messaging without maintaining conversation context.

2. Conversations API: For managing rich, contextual conversations and participant tracking.

Key Differences Between the Conversations API in Connectivity Platform and Bird CRM

Feature	Connectivity Platform	Bird CRM
Messaging Flexibility	Messaging is only supported through Conversations API.	Messaging possible via both Channels API (direct messages) and Conversations API (contextual interactions).
Conversation Lifecycle	Conversations created or updated automatically when sending a message to a specific contact.	Conversations automatically created or updated when sending a message using the Conversations API.
Participant Management	Limited participant types (e.g., users and contacts).	Supports multiple participant types: user, contact, flow, accessKey.
Template Synchronisation	Manual process with limited visibility.	Supports automated template synchronisation for WhatsApp WABAs.
Channel Management	Managed through legacy tools.	Channels and WABAs managed programmatically or via the UI.
Event Handling	Basic event subscription for status updates.	Advanced webhook management for message lifecycle events, including delivery and read receipts.
Rich Messaging	Supported rich text and template-based messaging for specific channels (e.g., WhatsApp).	Extended support for multimedia, templates, metadata, and advanced messaging workflows across all supported channels.

Key enhancement: Messaging flexibility

The new Bird CRM platform introduces greater flexibility for handling different types of messaging workflows.

Messaging API Options

1. Channels API

   • Purpose: For lightweight messaging without maintaining conversation context.

   • Best Suited For: Direct, one-off messages like notifications.

2. Conversations API

   • Purpose: Managing complex interactions with multiple participants and detailed context.

   • Ideal Uses:

     • Customer service workflows

     • Agent-customer communication

     • Automation flows

This flexibility ensures the system can meet various messaging needs, from simple alerts to comprehensive customer.