API reference

Record types

List record types

This endpoint returns the available record types, e.g. movie, organization, person, etc.

Response parameters

Name	Description
name	Name of the record type.
label	Label of the record type.
creatable	The record type supports operation create.
updatable	The record type supports operation update.
readable	The record type supports operation read.
searchable	The record type supports operation search.
searchesIn	The list of parameters to search by in the records of the record type.
deletable	The record type supports operation delete.
triggerable	The record type supports firing webhooks when a new event is logged. The record type records the date and time of the event.

Endpoint to retrieve available record types.

This endpoint retrieves available record types.

GEThttps://app-academy.make.com/api/v3/recordTypes

Header parameters

Response

200

OK

Body

application/json

recordTypesResponseRecordTypesArray (array of ResponseRecordTypes (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/recordTypes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "recordTypes": [
    {
      "name": "movie",
      "label": "Movie",
      "creatable": false,
      "updatable": false,
      "readable": false,
      "searchable": false,
      "searchesIn": [
        "text"
      ],
      "deletable": false
    }
  ]
}

Retrieve a record type

This endpoint retrieves the JSON file of a record type. This JSON file contains the list of parameters available in the record type.

Response parameters

Name	Description
name	Name of the parameter.
label	Label of the parameter.
mandatory	The parameter is mandatory.
readable	The parameter is returned in the response body when the record is fetched.
updatable	The parameter can be used to create/update a record.
refersTo	Name of the record type to which the parameter refers. Only available for the parameters of type ID.
type	JSON type of the parameter, e.g. text, number, array.
nestedParameters	The parameters that are nested to the parameter.

Retrieves a record type.

This endpoint retrieves JSON file of a record type.

GEThttps://app-academy.make.com/api/v3/recordTypes/{name}

Path parameters

name*string

Name of the record to work with.

Header parameters

Response

200

OK

Body

application/json

recordParametersResponseRecordTypeDetailArray (array of ResponseRecordTypeDetail (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/recordTypes/{name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "recordParameters": [
    {
      "name": "id",
      "label": "ID",
      "mandatory": false,
      "readable": false,
      "updatable": false,
      "refersTo": "organization",
      "type": "text",
      "nestedParameters": []
    }
  ]
}

Records

Search records

Retrieves records. E.g. movies.

Retrieves records. E.g. movies.

POSThttps://app-academy.make.com/api/v3/{recordType}/query

Path parameters

recordType*string

Type of the record to retrieve, e.g. movie.

Query parameters

Header parameters

Body

application/json

any

Response

200

OK

Body

application/json

totalRecordsReturnednumber

recordsResponseRecordsArray (array of ResponseRecords (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/{recordType}/query', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

{
  "totalRecordsReturned": 5,
  "records": [
    {
      "id": "1dca6a93fcf1",
      "name": "Robert Downey Jr.",
      "createdAt": "2023-04-13T17:04:47+00:00",
      "updatedAt": "2023-04-13T17:04:47+00:00"
    }
  ]
}

Filtering records

The search records endpoint supports chained filters. The filter is sent in body of the request.

{
   "or":[
      {
         "and":[
            {
               "property": "name",
               "startsWith": "R"
            },
            {
               "property": "name",
               "contains": "o"
            }
         ]
      },
      {
         "and":[
            {
               "property": "name",
               "startsWith": "G"
            },
            {
               "property": "name",
               "contains": "w"
            }
         ]
      }
   ]
}

In addition to chained filters, records can be queried with single filters as well.

{
   "and":[
      {
         "property": "name",
         "startsWith": "R"
      }
   ]
}

Supported operators for filtering

• startsWith

• endsWith

• contains

• equalsTo

Retrieve a record

Retrieves the record by its ID.

Retrieves the record by its ID.

GEThttps://app-academy.make.com/api/v3/{recordType}/{id}

Path parameters

recordType*string

Type of the record to retrieve, e.g. movie.

id*string

ID of the record to work with.

Header parameters

Response

200

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/{recordType}/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create a record

Each user is granted access to 6 default movie records that cannot be updated or deleted.

Each user can create up to 14 movie records, resulting in 20 retrievable movie records.

Creates a new record. E.g. a movie.

Creates a new record. E.g. a movie.

POSThttps://app-academy.make.com/api/v3/{recordType}

Path parameters

recordType*string

Type of the record to retrieve, e.g. movie.

Header parameters

Response

200

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/{recordType}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

The body of the request contains the parameters available in the selected record type.

Update a record

Only the records created by the user can be updated.

Updates the record by its ID.

Updates the record by its ID.

PATCHhttps://app-academy.make.com/api/v3/{recordType}/{id}

Response

200

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/{recordType}/{id}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

The body of the request contains the parameters available in the selected record type.

Delete a record

Only the records created by the user can be deleted.

Deletes the record by its ID.

Deletes the record by its ID.

DELETEhttps://app-academy.make.com/api/v3/{recordType}/{id}

Response

200

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/{recordType}/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Files/Folders

Retrieve files or folders

Retrieves the list of files or folders.

Retrieves the list of files or folders.

GEThttps://app-academy.make.com/api/v3/files

Query parameters

Header parameters

Response

200

OK

Body

application/json

totalPagesnumber

itemsResponseFilesArray (array of ResponseFiles (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "totalPages": 2,
  "items": [
    {
      "name": "test.txt",
      "parent": "e4677852dffe",
      "id": "dj789jdj344i",
      "type": "folder"
    }
  ]
}

Download a file

Downloads a file.

Downloads a file.

GEThttps://app-academy.make.com/api/v3/files/{id}

Path parameters

id*string

ID of the record to work with.

Header parameters

Response

200

OK

Body

application/octet-stream

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Delete a file

Deletes a file.

Deletes a file.

DELETEhttps://app-academy.make.com/api/v3/files/{id}

Response

200

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Upload a file

Each user is granted access to 1 default record that cannot be deleted.

Each user can upload up to 1 file, resulting in 2 retrievable files.

The maximum size of a file one can upload to an upload session is 4 bytes. A single request within the upload session cannot exceed 1 byte. Example: If a file has 4 bytes, the file has to be split into 4 separate requests containing a block of data (bytes).

Step one: Open a slot for a file upload

Open a slot for an upload session and save the file's name and the given file path where the file should be uploaded.

Only one slot can be open at a time. The slot can be open for max 1 minute. The session is dropped if the file upload is not finished by that time or if the upload session ends up with an error.

Creates a session ID for a file upload. Stores a file name and the final location of the file (full path to the folder is required).

Creates a session ID for a file upload. Stores a file name and the final location of the file (full path to the folder is required).

POSThttps://app-academy.make.com/api/v3/files/upload/openSlot

Header parameters

Body

application/json

path*string

fileName*string

Response

200

OK

Body

application/json

session_idstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files/upload/openSlot', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "path": "/8c6e22b7f1a0/e4673b2dff5e/1dca6a93fcf1",
      "fileName": "test.txt"
    }),
});
const data = await response.json();

Response

{
  "session_id": "e4677852dffe"
}

Step two: Upload the first block of data of the file

Upload the first block of data to an upload session.

Uploads the first block of data of a file.

Uploads the first block of data of a file.

POSThttps://app-academy.make.com/api/v3/files/upload/start

Header parameters

Body

application/octet-stream

string (binary)

Response

200

OK

Body

application/json

session_idstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files/upload/start', {
    method: 'POST',
    headers: {
      "Content-Type": "application/octet-stream"
    },
    body: JSON.stringify("raw(binary)"),
});
const data = await response.json();

Response

{
  "session_id": "e4677852dffe"
}

Step three: Upload the other blocks of data of the file

Append more data to an upload session.

Uploads the other blocks of data (bytes) of a file, except the last block of data.

Uploads the other blocks of data (bytes) of a file, except the last block of data.

POSThttps://app-academy.make.com/api/v3/files/upload/append

Header parameters

Body

application/octet-stream

string (binary)

Response

200

OK

Body

application/json

session_idstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files/upload/append', {
    method: 'POST',
    headers: {
      "Content-Type": "application/octet-stream"
    },
    body: JSON.stringify("raw(binary)"),
});
const data = await response.json();

Response

{
  "session_id": "e4677852dffe"
}

Step four: Upload the last block of data of the file and close the session

Finish the upload session by uploading the last block (byte) of the file's data.

Uploads the last block of data of a file and closes the session.

Uploads the last block of data a file and closes the session.

POSThttps://app-academy.make.com/api/v3/files/upload/finish

Header parameters

Body

application/octet-stream

string (binary)

Response

200

OK

Body

application/json

file_idstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/files/upload/finish', {
    method: 'POST',
    headers: {
      "Content-Type": "application/octet-stream"
    },
    body: JSON.stringify("raw(binary)"),
});
const data = await response.json();

Response

{
  "file_id": "test.txt"
}

Webhooks

Verification of the webhook

The Make Academy API version 3 uses a digital signature which is generated using the secret key entered when creating a webhook and the body of the webhook’s request. This data is contained within the Signature header.

The header contains the SHA algorithm used to generate the signature. To verify that the request originates from the App Academy API, you'll need to compute the HMAC 256 using your secret key and the body and compare it to the signature contained in the header. The successful matching of these values ensures that the webhook's source is the App Academy API.

Example of computing HMAC 256 in JavaScript

import * as crypto from 'crypto';

function generateHMACSHA256(secretKey: string, data: string): string {
  const hmac = crypto.createHmac('sha256', secretKey);
  hmac.update(data);
  return hmac.digest('hex');
}

const secretKey = 'yourSecretKey';
const body = 'yourBodyContent';

const hmacSHA256 = generateHMACSHA256(secretKey, body);
console.log(`HMAC-SHA256: ${hmacSHA256}`);

Responding to the webhook

You must set up the verification of the webhook.

When a webhook is attached, the verification payload is sent to the webhook. You must respond with the correct HTTP code:

• 200 for correct signature

• 400 for incorrect signature

For the 400 code, you must respond with the following response:

Headers

"Content-type": "application/json"

Body

{
    "message": "Invalid signature"
}

Webhook's payload

Payload parameters

Name	Description
eventType	The type of event that fired the webhook. Available types: verification, create, update.
data	The body of the record type.

{
    "eventType": "verification",
    "data": {...}
}

Attach a webhook

Attaches a new webhook.

Attaches a new webhook.

POSThttps://app-academy.make.com/api/v3/webhooks

Header parameters

Body

application/json

url*string

secretKey*string

recordType*string

Response

200

OK

Body

application/json

hookIdstring

secretKeystring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/webhooks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "text",
      "secretKey": "text",
      "recordType": "text"
    }),
});
const data = await response.json();

Response

{
  "hookId": "text",
  "secretKey": "text"
}

Detach a webhook

Detaches an existing webhook.

Detaches an existing webhook.

DELETEhttps://app-academy.make.com/api/v3/webhooks/{id}

Path parameters

id*string

ID of the record to work with.

Header parameters

Response

200

OK

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v3/webhooks/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();