Trigger File Imports

This API can be used to trigger scheduled file imports. Periodic imports can be triggered to run using this API if the import has not expired and is in any of the following states- Scheduled, Successful, Partially Successful, and Failed.

POST /fileimports/trigger/{schedule_id}

Trigger File Imports

cURL

curl --request POST \
  --url https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'MOE-APPKEY: <moe-appkey>'

import requests

url = "https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id}"

headers = {
    "MOE-APPKEY": "<moe-appkey>",
    "Authorization": "Basic <encoded-value>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'MOE-APPKEY': '<moe-appkey>', Authorization: 'Basic <encoded-value>'}
};

fetch('https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "MOE-APPKEY: <moe-appkey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("MOE-APPKEY", "<moe-appkey>")
	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id}")
  .header("MOE-APPKEY", "<moe-appkey>")
  .header("Authorization", "Basic <encoded-value>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://fileimports-data-api-0{dc}.moengage.com/v1.0/data/fileimports/trigger/{schedule_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["MOE-APPKEY"] = '<moe-appkey>'
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

200

success_response

{ "status": "success", "message": "Triggered Import Successfully" }

Rate Limit

This API can be triggered once in every five minutes for a specific schedule_id. A Bad request response (400) response will be sent if this is exceeded.

Postman Collections

We have made it easy for you to test the APIs. Click here to view it in Postman.

FAQs

• Does the trigger API change the import schedule?

No, the schedule still remains the same as originally set up in the MoEngage Dashboard.

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 WORKSPACE ID that has to be passed along with the request.You can find your MoEngage Workspace ID at Settings -> Account -> APIs -> Workspace ID (earlier app id).

Path Parameters

schedule_id · string · required

This field specifies the Import ID(the unique identifier for the import) of the import that needs to be triggered. You can find the Import ID in the MoEngage Dashboard on the Imports History page. Click Actions → View import to view the Import Details. You can also view the Import ID in the email notification received once the import has been set up.

Response

200

application/json

This response is returned when the request is processed successfully.

status · string

This field contains the status of the request and specifies whether the request was successful.

Example:

"success, failure"

message · string

This field contains information about whether the request was successful or not.

Example:

"Trigger Import Successful"