Firebase Dynamic Linksβ

Improve this doc

This plugin is still in beta stage and may not work as expected. Please submit any issues to the plugin repo.

Cordova plugin for Firebase Invites and Firebase Dynamic Links

Variables APP_DOMAIN and APP_PATH specify web URL where your app will start an activity to handle the link. They also used to setup support for App Indexing. Variable REVERSED_CLIENT_ID can be found in your GoogleService-Info.plist under the same key name. Variable PHOTO_LIBRARY_USAGE_DESCRIPTION specifies required value for NSPhotoLibraryUsageDescription on iOS. Go to firebase console and export google-services.json and GoogleService-Info.plist. Put those files into the root of your cordova app folder.


Preferences GoogleIOSClientId and GoogleAndroidClientId are used to setup dynamic links when you have an app for several platforms. You can find values at your GoogleService-Info.plist (key ANDROID_CLIENT_ID) and google-services.json (key client[0].oauth_client[0].client_id).


<platform name="android">
    <preference name="GoogleIOSClientId" value="..." />
<platform name="ios">
    <preference name="GoogleAndroidClientId" value="..." />



  1. Install the Cordova and Ionic Native plugins:
    $ ionic cordova plugin add cordova-plugin-firebase-dynamiclinks --save --variable APP_DOMAIN="" --variable APP_PATH="/"
    $ npm install --save @ionic-native/firebase-dynamic-links
  2. Add this plugin to your app's module

Supported platforms


import { FirebaseDynamicLinks } from '@ionic-native/firebase-dynamic-links';

constructor(private firebaseDynamicLinks: FirebaseDynamicLinks) { }

// The deepLink and callToActionText properties are optional
const options: DynamicLinksOptions = {
  title: 'My Title';
  message: 'My message';
  deepLink: '';
  callToActionText: 'Message on button';

  .then((res: any) => console.log(res))
  .catch((error: any) => console.error(error));

  .then((res: any) => console.log(res)) //Handle the logic here after opening the app with the Dynamic link
  .catch((error:any) => console.log(error));

Instance Members


Registers callback that is triggered on each dynamic link click.

Returns: Promise<any> Returns a promise


Display invitation dialog.

Param Type Details
options DynamicLinksOptions

Some param to configure something

Returns: Promise<any> Returns a promise


Param Type Details
title string
message string
deepLink string (optional)
callToActionText string (optional)