メインコンテンツへスキップ
POST
Test Connection API

承認

Authorization
string
header
必須

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.

Data APIs also support OAuth 2.0. For more information, refer to OAuth 2.0.

ヘッダー

MOE-APPKEY
string
必須

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).

ボディ

application/json

Set the Content-Type header to application/json.

app_id
string
必須

Your MoEngage Workspace ID.

app_secret
string
必須

Your MoEngage Data API Key.

source
string
必須

The tool from where you are sending the request.

例:

"test"

region
string
必須

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

例:

"01"

レスポンス

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"

例:

"success"

app_name
string

This field contains the workspace name of your MoEngage workspace

例:

"Your_Workspace_ID"