Test Connection API

This API validates if the entered endpoint details are valid. It verifies if the provided endpoint URL, workspace ID, and data key are accessible and responds without any errors.

POST /integrations/authentication

Test Connection API

cURL

curl --request POST \
  --url https://api-{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

Authentication is done via Basic Auth. This requires a base64-encoded string of your credentials in the format 'username:password'.

• Username: Use your MoEngage workspace ID (also known as the App ID). You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).
• Password: Use your API Key, which you can find within the Data tile.

Note: After you generate and save the Data API Key, DO NOT generate a new key unless there is a security breach. After you generate a different Data API key and save it, the authentication will start failing. You must update your existing data tracking.

For more information on authentication and getting your credentials, refer here.

Headers

MOE-APPKEY · string · required

This is the Workspace ID of your MoEngage account that must be passed with the request. You can find it in the MoEngage dashboard at Settings > Account > APIs > Workspace ID (earlier app id).

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"