Test Connection API

The Test Connection API allows you to validate if the entered endpoint details are valid. The API verifies if the provided endpoint URL, workspace ID an data key is accessible and responds without any errors.

POST /integrations/authentication

Test Connection API

cURL

curl --request POST \
  --url https://api-0{dc}.moengage.com/v1/integrations/authentication \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'MOE-APPKEY: <moe-appkey>' \
  --data '
{
  "app_id": "********",
  "app_secret": "**********",
  "source": "test",
  "region": "01"
}
'

200

{
  "status": "success",
  "app_name": "PI-Prod-DC01"
}

Authorizations

Authorization · string · header · required

This authentication parameter, used for access control, must be passed along with the request. The API request will be authenticated through Basic Authentication. Basic Authentication sends a Base64-encoded string containing your username and password with every API request. It encodes a 'username:password' string in Base64 and appends the encoded string with 'Basic '. This string is included in the authorization header as shown below:

{"Authorization: Basic Base64_ENCODED_WORKSPACEID_APIKEY=="}

The username and password details can be obtained from the MoEngage Dashboard. If you're using the API for the first time, follow these steps:

1. Navigate to Settings -> Account -> APIs.
2. Copy the following details:
   • Username: Under Workspace ID (earlier app id), click the copy icon to copy the username.
   • Password: In the API keys section, click the copy icon in the Data tile to copy the API key.

Use these details to authenticate the API requests.

Headers

MOE-APPKEY · string · required

This is your MoEngage account's data API keythat has to be passed along with the request. You can find it at Settings -> Account -> APIs -> API Keys -> Data.

Example:

"{MoEngage data API key}"

Authorization · string · required

This authentication parameter, used for access control, must be passed along with the request. To generate the authentication header, refer to Authentication.

Example:

"Basic bmF2ZWVua3VtYXI6bW9lbmdhZ2U=="

Body

application/json

Set the Content-Type header to application/json.

app_id · string · required

Your MoEngage Workspace ID.

app_secret · string · required

Your MoEngage Data API Key.

source · string · required

The tool from where you are sending the request.

Example:

"test"

region · string · required

Your MoEngage region (e.g., "01" for DC-01).

Example:

"01"

Response

200

application/json

Success. This response is returned when the request is processed successfully.

status · string

This field contains the status of the request and denotes whether it was successful or not. Example: "status": "success", "status": "error"

Example:

"success"

app_name · string

This field contains the workspace name of your MoEngage workspace

Example:

"PI-Prod-DC01"