Docs Menu
Docs Home
/ /
Atlas App Services
/ /

Configure Third-Party Services [Deprecated]

Important

Third Party Services & Push Notifications Deprecation

Third party services and push notifications in App Services have been deprecated in favor of creating HTTP endpoints that use external dependencies in functions.

Webhooks have been renamed to HTTPS Endpoints with no change in behavior. You should migrate existing Webhooks.

Existing services will continue to work until September 30, 2025.

Because third party services and push notifications are now deprecated, they have been removed by default from the App Services UI. If you need to manage an existing third party service or push notification, you can add the configurations back to the UI by doing the following:

  • In the left navigation, under the Manage section, click App Settings.

  • Enable the toggle switch next to Temporarily Re-Enable 3rd Party Services, and then save your changes.

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

1
  1. Click Services in the left navigation menu.

  2. Click Add a Service.

2
  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
1

Use your MongoDB Atlas Admin API Key to log in to the CLI:

appservices login --api-key="<my api key>" --private-api-key="<my private api key>"
2

Get a local copy of your App's configuration files. To get the latest version of your App, run the following command:

appservices pull --remote="<Your App ID>"

You can also export a copy of your application's configuration files from the UI or with the Admin API. To learn how, see Export an App.

3

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
4

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

type

Required. The type of the configured service.

Service Name

name

Required. The name of the configured service.

Note

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

Configuration

config

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.

5

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

Back

Webhook Requests & Responses

On this page

  • Overview
  • Procedure