Skip to content

Sample manifest file

Here is a sample manifest file that illustrates the full syntax and structure of the manifest file.

{
    "serverUrl": "https://xxxx.ngrok.app",
    "redirectUri": "https://ringcentral.github.io/ringcentral-embeddable/redirect.html",
    "author": {
        "name": "Test Developer",
        "websiteUrl": ""
    },
    "platforms": {
        "testCRM": {
            "logoUrl": "https://avatars.githubusercontent.com/u/6549285?s=200&v=4",
            "documentationUrl": "https://ringcentral.github.io/rc-unified-crm-extension",
            "releaseNotesUrl": "https://ringcentral.github.io/rc-unified-crm-extension/release-notes/",
            "getSupportUrl": "https://community.ringcentral.com/topic/new?fid=22",
            "writeReviewUrl": "https://chromewebstore.google.com/detail/ringcentral-crm-extension/kkhkjhafgdlihndcbnebljipgkandkhh/reviews",
            "urlIdentifier": "*.labs.ringcentral.com/*",
            "name": "testCRM",
            "displayName": "Test CRM",
            "requestConfig": {
                "timeout": 30
            },
            "auth": {
                "type": "apiKey",
                "apiKey": {
                    "page": {
                        "title": "test CRM",
                        "content": [
                            {
                                "const": "apiKey",
                                "title": "apiKey",
                                "type": "string",
                                "required": true
                            }
                        ]
                    }
                },
                "oauth": {
                    "authUrl": "",
                    "clientId": "",
                    "redirectUri": "https://ringcentral.github.io/ringcentral-embeddable/redirect.html",
                    "customState": "",
                    "scope": ""
                }
            },
            "canOpenLogPage": false,
            "contactTypes": [
                {
                  "display": "TestContactType",
                  "value": "testContact"
                },
                {
                  "display": "Contact",
                  "value": "cta"
                }
            ],
            "embeddedOnCrmPage": {
                "welcomePage": {
                    "docLink": "https://ringcentral.github.io/rc-unified-crm-extension/",
                    "videoLink": "https://youtu.be/pQgdsAR1UCI"
                }
            },
            "page": {
                "callLog": {
                    "additionalFields": [
                        {
                            "const": "associatedDeal",
                            "title": "Deals",
                            "type": "selection",
                            "contactDependent": true
                        },
                        {
                            "const": "address",
                            "title": "Address",
                            "type": "inputField",
                            "contactDependent": false
                        }
                    ]
                },
                "messageLog": {
                    "additionalFields": [
                        {
                            "const": "associatedDeal",
                            "title": "Deals",
                            "type": "selection",
                            "contactDependent": true
                        },
                        {
                            "const": "address",
                            "title": "Address",
                            "type": "inputField",
                            "contactDependent": false
                        }
                    ]
                }
            }
        }
    },
    "version": "1.0.10"
}