Configure Third-Party Services

On this page


You can create and configure interfaces for all external service from the Realm UI or by importing a service configuration directory. Select the tab below that corresponds to the method you want to use.



Create a New Service

  1. Click Services in the left navigation menu.
  2. Click Add a Service.

Enter Configuration Values

  1. Select the type of service you wish to create from the list.

  2. Enter a Service Name that uniquely identifies the service.

  3. Enter additional configuration values specific to the type of service you are creating. Some Service configuration values are private and require you to create and reference a Secret that contains the configuration value.

    Refer to the individual service reference pages for details on the configuration parameters for each type of service.

  4. Click Add Service to save the service.

An example service configuration in the UI

Export Your Realm Application

To create new incoming webhook with realm-cli, you need a previously created application configuration.

You can export your application from the Import/Export App tab of the Deploy page in the Realm UI, or by running the following command from an authenticated instance of realm-cli:

realm-cli export --app-id=<App ID>

Create a Service Configuration Directory

Create a new subdirectory in the /services folder of the application directory that you exported. The name of the subdirectory should match the configured name of the service.

mkdir -p services/myService

Add a Service Configuration File

Add a file named config.json to the new service directory. The configuration file should have the following form:

  "type": <boolean>,
  "name": <string>,
  "config": <document>
Configuration Value Description

Service Type

Required. The type of the configured service.

Service Name


Required. The name of the configured service.


Each service interface in your application must have a unique name.


Required. A document that contains configuration values specific to the type of the service you are configuring. To find the configuration values for a specific service, refer to that service’s reference page.

Import the Service

Once you have added the appropriate configuration files to the service subdirectory, you can import the service into your application.

Navigate to the root of the application directory and run the following command:

realm-cli import