SDK Apps > Modules
Retrieves a list of all apps available to the user.
true
true
1
Successful response
GET /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"appModules": [
{
"name": "postmanModule5",
"label": "BezVisKam",
"typeId": 1,
"public": false,
"approved": false,
"description": "Bleeeeee",
"crud": "read"
},
{
"name": "getEntity",
"label": "Get Entity",
"typeId": 4,
"public": false,
"approved": false,
"description": "Retrieves the given entity.",
"crud": null
}
]
}
Create app module.
Module type id. Allowed values:
- 1 = TRIGGER (Trigger - polling) Use if you wish to watch for any changes in your app/service. Examples are Watch a New Book, which will be triggered whenever a new book has been added to the library.
- 4 = ACTION Use if the API endpoint returns a single response. Examples are Create a book, Delete a book or Get a Book.
- 9 = SEARCH Use if the API endpoint returns multiple items. An example is List Books that will find specific books according to search criteria.
- 10 = CONVERGER (Instant Trigger / webhook) Use if the API endpoint has a webhook available (dedicated or shared). Example is Watch a New Event.
- 11 = HITL (Responder) Use if you need to send a processed data back to a webhook.
- 12 = RETURNER (Universal) Use if you want to enable users to perform an arbitrary API call to the service. Examples are Make an API Call and Execute a GraphQL Query.
4
Possible values: Module init mode:
blank
- Creates a new blank module (code is empty).example
- Creates a module from amodel
app (which contains the example codes).module
- Creates module from existing user's module.
blank
Possible values: Successful response
POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 96
{
"name": "getEntity",
"typeId": 4,
"label": "Get Entity",
"description": "Retrieves the given entity."
}
Successful response
{
"appModule": {
"name": "getEntity",
"label": "Get Entity",
"description": "Retrieves the given entity.",
"typeId": 4,
"crud": null,
"connection": null,
"webhook": null
}
}
Retrieves a list of all apps available to the user.
true
true
1
Successful response
GET /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"appModule": {
"name": "getEntity",
"label": "Get Entity",
"description": "Retrieves the given entity.",
"typeId": 4,
"public": false,
"approved": false,
"crud": null,
"connection": null,
"altConnection": null,
"webhook": null
}
}
Retrieves a list of all apps available to the user.
true
true
1
Successful response
DELETE /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"appModule": "getEntity"
}
Retrieves a list of all apps available to the user.
true
true
1
application/json
Successful response
PATCH /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93
{
"label": "Get Order",
"description": "Retrieves the order by its id.",
"connection": "charlie-1"
}
Successful response
{
"appModule": {
"name": "getEntity",
"label": "Get Order",
"description": "Retrieves the order by its id.",
"typeId": 4,
"crud": null,
"connection": "charlie-1",
"altConnection": null,
"webhook": null
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/api HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1724
{
"url": "text",
"baseUrl": "text",
"encodeUrl": true,
"method": "GET",
"headers": {
"ANY_ADDITIONAL_PROPERTY": true
},
"qs": {
"ANY_ADDITIONAL_PROPERTY": true
},
"ca": "text",
"body": {},
"type": "json",
"temp": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"condition": true,
"aws": {
"key": "text",
"secret": "text",
"session": "text",
"bucket": "text",
"sign_version": "2"
},
"gzip": false,
"followRedirects": true,
"followAllRedirects": true,
"log": {
"sanitize": [
"text"
]
},
"oauth": {
"consumer_key": "text",
"consumer_secret": "text",
"private_key": "text",
"token": "text",
"token_secret": "text",
"verifier": "text",
"signature_method": "HMAC-SHA1",
"transport_method": "header",
"body_hash": true
},
"pagination": {
"mergeWithParent": true,
"url": "text",
"method": "GET",
"headers": {
"ANY_ADDITIONAL_PROPERTY": true
},
"qs": {
"ANY_ADDITIONAL_PROPERTY": true
},
"body": {},
"condition": true
},
"response": {
"type": {
"ANY_ADDITIONAL_PROPERTY": "automatic"
},
"valid": true,
"limit": 1,
"error": "text",
"iterate": "text",
"temp": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"output": {},
"trigger": {
"type": "date",
"order": "asc",
"id": "text",
"date": "text"
},
"data": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"metadata": {
"value": "text",
"type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"uid": "text",
"oauth": {
"consumer_key": "text",
"consumer_secret": "text",
"private_key": "text",
"token": "text",
"token_secret": "text",
"verifier": "text",
"signature_method": "HMAC-SHA1",
"transport_method": "header",
"body_hash": true
},
"wrapper": "{{output}}",
"expires": "text"
},
"output": {},
"iterate": "text",
"respond": {
"type": "json",
"status": 1,
"headers": {
"ANY_ADDITIONAL_PROPERTY": true
},
"body": {}
},
"verification": {
"condition": true,
"respond": {
"type": "json",
"status": 1,
"headers": {
"ANY_ADDITIONAL_PROPERTY": true
},
"body": {}
}
},
"repeat": {
"condition": "text",
"delay": 1,
"limit": 1
}
}
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
Request URL
This directive controls the encoding of URLs. It is on by default, so if you have any special characters in your URL, they will be automatically encoded. But there might be situations where you don't want your URL to be encoded automatically, or you want to control what parts of the URL are encoded. To do this, set this flag to false.
true
^.*[{][{].*[}][}].*$
Custom Certificate Authority
Request body
^.*[{][{].*[}][}].*$
true
Add an Accept-Encoding header to request compressed content encodings from the server (if not already present) and decode supported content encodings in the response.
false
This directive specifies whether to follow GET HTTP 3xx responses as redirects or never.
true
This directive specifies whether to follow non-GET HTTP 3xx responses as redirects or never.
true
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/epoch HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1281
{
"url": "text",
"encodeUrl": true,
"method": "GET",
"headers": {
"ANY_ADDITIONAL_PROPERTY": true
},
"qs": {
"ANY_ADDITIONAL_PROPERTY": true
},
"ca": "text",
"body": {},
"type": "json",
"temp": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"condition": true,
"aws": {
"key": "text",
"secret": "text",
"session": "text",
"bucket": "text",
"sign_version": "2"
},
"oauth": {
"consumer_key": "text",
"consumer_secret": "text",
"private_key": "text",
"token": "text",
"token_secret": "text",
"verifier": "text",
"signature_method": "HMAC-SHA1",
"transport_method": "header",
"body_hash": true
},
"gzip": false,
"followRedirects": true,
"followAllRedirects": true,
"log": {
"sanitize": [
"text"
]
},
"pagination": {
"mergeWithParent": true,
"url": "text",
"method": "GET",
"headers": {
"ANY_ADDITIONAL_PROPERTY": true
},
"qs": {
"ANY_ADDITIONAL_PROPERTY": true
},
"body": {},
"condition": true
},
"repeat": {
"condition": "text",
"delay": 1,
"limit": 1
},
"response": {
"type": {
"ANY_ADDITIONAL_PROPERTY": "automatic"
},
"valid": true,
"limit": 1,
"error": "text",
"iterate": "text",
"temp": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"output": {
"date": null,
"label": null,
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"oauth": {
"consumer_key": "text",
"consumer_secret": "text",
"private_key": "text",
"token": "text",
"token_secret": "text",
"verifier": "text",
"signature_method": "HMAC-SHA1",
"transport_method": "header",
"body_hash": true
}
}
}
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/interface HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 868
[
{
"name": "text",
"label": "text",
"help": "text",
"type": "any",
"semantic": "text",
"default": true,
"advanced": true,
"required": true,
"grouped": true,
"dynamic": true,
"multiline": true,
"sort": "text",
"sequence": true,
"schema": null,
"tags": "strip",
"coder": true,
"multiple": true,
"visible": "text",
"convert": {
"type": "text",
"format": "text",
"timezone": "text",
"name": "text",
"label": "text",
"names": "text"
},
"editable": true,
"mappable": true,
"time": true,
"rpc": {
"url": "text",
"label": "text",
"parameters": []
},
"mode": "edit",
"labels": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"spec": null,
"codepage": "text",
"pattern": "text",
"nested": null,
"options": [
{
"label": "text",
"value": "text",
"description": "text",
"nested": null,
"default": true,
"short": "text"
}
],
"extension": "text",
"validate": true,
"title": "text",
"text": "text",
"closable": true,
"theme": "text",
"badge": "text"
}
]
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/parameters HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 868
[
{
"name": "text",
"label": "text",
"help": "text",
"type": "any",
"semantic": "text",
"default": true,
"advanced": true,
"required": true,
"grouped": true,
"dynamic": true,
"multiline": true,
"sort": "text",
"sequence": true,
"schema": null,
"tags": "strip",
"coder": true,
"multiple": true,
"visible": "text",
"convert": {
"type": "text",
"format": "text",
"timezone": "text",
"name": "text",
"label": "text",
"names": "text"
},
"editable": true,
"mappable": true,
"time": true,
"rpc": {
"url": "text",
"label": "text",
"parameters": []
},
"mode": "edit",
"labels": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"spec": null,
"codepage": "text",
"pattern": "text",
"nested": null,
"options": [
{
"label": "text",
"value": "text",
"description": "text",
"nested": null,
"default": true,
"short": "text"
}
],
"extension": "text",
"validate": true,
"title": "text",
"text": "text",
"closable": true,
"theme": "text",
"badge": "text"
}
]
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/samples HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"ANY_ADDITIONAL_PROPERTY": "anything"
}
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/scope HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8
[
"text"
]
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
Available sections: api, epoch, parameters, expect, interface, samples, scope
true
true
1
Successful response
GET /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleSection} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"url": "/api/users",
"method": "GET",
"qs": {},
"body": {},
"headers": {},
"response": {
"iterate": "{{body.users}}",
"trigger": {
"id": "{{item.id}}",
"date": "{{item.created}}",
"type": "string",
"format": "date",
"order": "desc"
},
"output": "{{item}}",
"limit": "{{parameters.limit}}"
}
}
true
true
1
text/plain
Successful respons
POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleVisibility} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful respons
true
Retrieves a list of all apps available to the user.
true
true
1
Successful response
POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/clone HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"newName": "apicek"
}
Successful response
{
"module": {
"name": "apicek",
"label": "Testicek (clone)",
"description": "Těstíčko.",
"typeId": 4,
"connection": "multiverse",
"webhook": null,
"crud": null
}
}
true
true
1
text/plain
Successful response
POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleDeprecation} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"changed": true
}
Update module consumable
Successful response
PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleConsumable}?app=text&version=1 HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112
{
"centireditsFormula": "text",
"centireditsFormulaDescription": "text",
"centireditsFormulaDocumentationUrl": "text"
}
Successful response
{
"name": "text"
}