Incomplete executions
If a scenario terminates unexpectedly because of an error, then the scenario run is discarded. You can set the scenario to store the failed scenario run as an incomplete execution. With that, if an error occurs in your scenario, you can resolve it manually and avoid losing data.
Read more about the incomplete executions.
Retrieves the list of incomplete executions of the specified scenario.
The ID value of the scenario. Use the API call GET /scenarios to get the ID of the scenario. If your scenario is placed in a folder, use the API call GET /scenarios-folders?teamId={teamId} first.
4GET /api/v2/dlqs HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"dlqs": [
{
"id": "ada87173334b44d1907270064edbd7dd",
"reason": "IP address is not valid.",
"created": "2019-11-04T10:52:57.260Z",
"size": 5,
"resolved": false,
"retry": true,
"attempts": 1
},
{
"id": "c29c4bf027c74bfc848e1803bf764447",
"reason": "IP address is not valid.",
"created": "2019-11-04T10:52:12.276Z",
"size": 5,
"resolved": false,
"retry": true,
"attempts": 0
}
]
}Deletes incomplete executions of the specified scenario. Specify the incomplete execution ID values in the ids array in the request body to delete the specified incomplete executions.
You can set the "all": true pair to delete all incomplete executions of the specified scenario. If you use the "all": true parameter, you have to specify the confirmed=true query parameter to confirm the deletion. Otherwise, the API call returns the error IM004 (406).
Add the exceptIds array to the request body to specify items you don't want to delete.
You get an error if you try to delete incomplete executions which are being processed. The rest of the specified items is still deleted.
The ID value of the scenario. Use the API call GET /scenarios to get the ID of the scenario. If your scenario is placed in a folder, use the API call GET /scenarios-folders?teamId={teamId} first.
4Set to true to confirm deleting the incomplete executions. Otherwise the API call fails with the error IM004 (406).
trueThe ID values of the scenario incomplete executions that you want to delete. Use the API call GET /dlqs/?scenarioId={scenarioId} to get the ID values of the webhook processing queue items.
If you are deleting all of the incomplete executions with the all:true parameter, you can specify the ID values of the incomplete executions that you want to keep. Use the API call GET /dlqs?scenarioId={scenarioId} to get the ID values of the incomplete executions.
Set to true to delete all incomplete executions of the specified scenario.
DELETE /api/v2/dlqs HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106
{
"ids": [
"85354fed3c804ec3a137b9ceb9dc9256",
"3b8badf2afd7447eb4340c24d1706b83"
],
"exceptIds": [],
"all": false
}Successful response
{
"dlqs": [
"f140d39b5c9c4c72b3bc4f3b7aa467de",
"74232267212a431ebab728158575ef65"
]
}Gets detail of the specified incomplete execution.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5GET /api/v2/dlqs/{dlqId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"dlq": {
"id": "a07e16f2ad134bf49cf83a00aa95c0a5",
"scenarioId": 3,
"scenarioName": "DLQS test",
"companyId": 1,
"companyName": "My Lab",
"resolved": false,
"deleted": false,
"index": 49,
"created": "2019-11-26T09:57:10.039Z",
"executionId": "55602700-e840-45bf-b18c-0aef214dd967",
"retry": false,
"attempts": 2,
"size": 21
}
}Required scope: datastores:write
DELETE /api/v2/dlqs/{dlqId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"dlq": "ada87173334b44d1907270064edbd7dd"
}Updates the specified incomplete execution.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5The blueprint you want to use to resolve the incomplete execution. If you download the blueprint from a Make scenario as a JSON object, you have to escape the blueprint contents to be able to send it as a string.
The module ID which caused the incomplete execution of the scenario.
PATCH /api/v2/dlqs/{dlqId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3595
{
"blueprint": "{\"name\":\"Integration of failing scenario\",\"flow\":[{\"id\":1,\"module\":\"http:ActionSendData\",\"version\":3,\"parameters\":{\"handleErrors\":false},\"mapper\":{\"ca\":\"\",\"qs\":[],\"url\":\"https://local.make.cloud/api/not-existing-page\",\"gzip\":true,\"method\":\"get\",\"headers\":[],\"timeout\":\"\",\"authPass\":\"\",\"authUser\":\"\",\"bodyType\":\"\",\"shareCookies\":false,\"parseResponse\":false,\"followRedirect\":true,\"useQuerystring\":false,\"rejectUnauthorized\":true},\"metadata\":{\"designer\":{\"x\":0,\"y\":0},\"restore\":{\"qs\":{\"mode\":\"chose\",\"items\":[]},\"method\":{\"mode\":\"chose\",\"label\":\"GET\"},\"headers\":{\"mode\":\"chose\",\"items\":[]},\"bodyType\":{\"label\":\"\"}},\"parameters\":[{\"name\":\"handleErrors\",\"type\":\"boolean\",\"label\":\"Evaluate all states as errors (except for 2xx and 3xx )\",\"required\":true}],\"expect\":[{\"name\":\"url\",\"type\":\"url\",\"label\":\"URL\",\"required\":true},{\"name\":\"method\",\"type\":\"select\",\"label\":\"Method\",\"required\":true,\"validate\":{\"enum\":[\"get\",\"head\",\"post\",\"put\",\"patch\",\"delete\"]}},{\"name\":\"headers\",\"spec\":[{\"name\":\"name\",\"type\":\"text\",\"label\":\"Name\",\"required\":true},{\"name\":\"value\",\"type\":\"text\",\"label\":\"Value\"}],\"type\":\"array\",\"label\":\"Headers\",\"labels\":{\"add\":\"Add a header\",\"edit\":\"Edit a header\"}},{\"name\":\"qs\",\"spec\":[{\"name\":\"name\",\"type\":\"text\",\"label\":\"Name\",\"required\":true},{\"name\":\"value\",\"type\":\"text\",\"label\":\"Value\"}],\"type\":\"array\",\"label\":\"Query String\",\"labels\":{\"add\":\"Add parameter\",\"edit\":\"Edit parameter\"}},{\"name\":\"bodyType\",\"type\":\"select\",\"label\":\"Body type\",\"validate\":{\"enum\":[\"raw\",\"x_www_form_urlencoded\",\"multipart_form_data\"]}},{\"name\":\"parseResponse\",\"type\":\"boolean\",\"label\":\"Parse response\",\"required\":true},{\"name\":\"authUser\",\"type\":\"text\",\"label\":\"User name\"},{\"name\":\"authPass\",\"type\":\"password\",\"label\":\"Password\"},{\"name\":\"timeout\",\"type\":\"uinteger\",\"label\":\"Timeout\",\"validate\":{\"max\":300,\"min\":1}},{\"name\":\"shareCookies\",\"type\":\"boolean\",\"label\":\"Share cookies with other HTTP modules\",\"required\":true},{\"name\":\"ca\",\"type\":\"cert\",\"label\":\"Self-signed certificate\",\"multiline\":true},{\"name\":\"rejectUnauthorized\",\"type\":\"boolean\",\"label\":\"Reject connections that are using unverified (self-signed) certificates\",\"required\":true},{\"name\":\"followRedirect\",\"type\":\"boolean\",\"label\":\"Follow redirect\",\"required\":true},{\"name\":\"useQuerystring\",\"type\":\"boolean\",\"label\":\"Disable serialization of multiple same query string keys as arrays\",\"required\":true},{\"name\":\"gzip\",\"type\":\"boolean\",\"label\":\"Request compressed content\",\"required\":true}]},\"onerror\":[{\"id\":2,\"module\":\"builtin:Break\",\"version\":1,\"parameters\":{},\"mapper\":{\"count\":\"3\",\"retry\":true,\"interval\":\"1\"},\"metadata\":{\"designer\":{\"x\":300,\"y\":0},\"restore\":{\"retry\":{\"mode\":\"chose\"}},\"expect\":[{\"name\":\"retry\",\"type\":\"boolean\",\"label\":\"Automatically complete execution\",\"required\":true},{\"name\":\"count\",\"type\":\"uinteger\",\"label\":\"Number of attempts\",\"required\":true},{\"name\":\"interval\",\"type\":\"uinteger\",\"label\":\"Interval between attempts\",\"required\":true}]}}]}],\"metadata\":{\"version\":1,\"scenario\":{\"autoCommit\":true,\"autoCommitTriggerLast\":true,\"roundtrips\":1,\"maxErrors\":3}}}",
"failer": 1
}Successful response
{
"dlq": {
"failer": 1,
"blueprint": {
"flow": [
{
"id": 1,
"mapper": {
"ca": "",
"qs": [],
"url": "https://local.make.cloud/api/not-existing-page",
"gzip": true,
"method": "get",
"headers": [],
"timeout": "",
"authPass": "",
"authUser": "",
"bodyType": "",
"shareCookies": false,
"parseResponse": false,
"followRedirect": true,
"useQuerystring": false,
"rejectUnauthorized": true
},
"module": "http:ActionSendData",
"onerror": [
{
"id": 2,
"mapper": {
"count": "3",
"retry": true,
"interval": "1"
},
"module": "builtin:Break",
"version": 1,
"metadata": {
"expect": [
{
"name": "retry",
"type": "boolean",
"label": "Automatically complete execution",
"required": true
},
{
"name": "count",
"type": "uinteger",
"label": "Number of attempts",
"required": true
},
{
"name": "interval",
"type": "uinteger",
"label": "Interval between attempts",
"required": true
}
],
"restore": {
"retry": {
"mode": "chose"
}
},
"designer": {
"x": 300,
"y": 0
}
},
"parameters": {}
}
],
"version": 3,
"metadata": {
"expect": [
{
"name": "url",
"type": "url",
"label": "URL",
"required": true
},
{
"name": "method",
"type": "select",
"label": "Method",
"required": true,
"validate": {
"enum": [
"get",
"head",
"post",
"put",
"patch",
"delete"
]
}
},
{
"name": "headers",
"spec": [
{
"name": "name",
"type": "text",
"label": "Name",
"required": true
},
{
"name": "value",
"type": "text",
"label": "Value"
}
],
"type": "array",
"label": "Headers",
"labels": {
"add": "Add a header",
"edit": "Edit a header"
}
},
{
"name": "qs",
"spec": [
{
"name": "name",
"type": "text",
"label": "Name",
"required": true
},
{
"name": "value",
"type": "text",
"label": "Value"
}
],
"type": "array",
"label": "Query String",
"labels": {
"add": "Add parameter",
"edit": "Edit parameter"
}
},
{
"name": "bodyType",
"type": "select",
"label": "Body type",
"validate": {
"enum": [
"raw",
"x_www_form_urlencoded",
"multipart_form_data"
]
}
},
{
"name": "parseResponse",
"type": "boolean",
"label": "Parse response",
"required": true
},
{
"name": "authUser",
"type": "text",
"label": "User name"
},
{
"name": "authPass",
"type": "password",
"label": "Password"
},
{
"name": "timeout",
"type": "uinteger",
"label": "Timeout",
"validate": {
"max": 300,
"min": 1
}
},
{
"name": "shareCookies",
"type": "boolean",
"label": "Share cookies with other HTTP modules",
"required": true
},
{
"name": "ca",
"type": "cert",
"label": "Self-signed certificate",
"multiline": true
},
{
"name": "rejectUnauthorized",
"type": "boolean",
"label": "Reject connections that are using unverified (self-signed) certificates",
"required": true
},
{
"name": "followRedirect",
"type": "boolean",
"label": "Follow redirect",
"required": true
},
{
"name": "useQuerystring",
"type": "boolean",
"label": "Disable serialization of multiple same query string keys as arrays",
"required": true
},
{
"name": "gzip",
"type": "boolean",
"label": "Request compressed content",
"required": true
}
],
"restore": {
"qs": {
"mode": "chose",
"items": []
},
"method": {
"mode": "chose",
"label": "GET"
},
"headers": {
"mode": "chose",
"items": []
},
"bodyType": {
"label": ""
}
},
"designer": {
"x": 0,
"y": 0
},
"parameters": [
{
"name": "handleErrors",
"type": "boolean",
"label": "Evaluate all states as errors (except for 2xx and 3xx )",
"required": true
}
]
},
"parameters": {
"handleErrors": false
}
}
],
"name": "Integration of failing scenario",
"metadata": {
"version": 1,
"scenario": {
"maxErrors": 3,
"autoCommit": true,
"roundtrips": 1
}
}
}
}
}Gets the blueprint of the scenario that caused the incomplete execution.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5GET /api/v2/dlqs/{dlqId}/blueprint HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"code": "OK",
"response": {
"blueprint": {
"flow": [
{
"id": 1,
"mapper": {
"ca": "",
"qs": [],
"url": "https://local.make.cloud/api/not-existing-page",
"gzip": true,
"method": "get",
"headers": [],
"timeout": "",
"authPass": "",
"authUser": "",
"bodyType": "",
"shareCookies": false,
"parseResponse": false,
"followRedirect": true,
"useQuerystring": false,
"rejectUnauthorized": true
},
"module": "http:ActionSendData",
"onerror": [
{
"id": 2,
"mapper": {
"count": "3",
"retry": true,
"interval": "1"
},
"module": "builtin:Break",
"version": 1,
"metadata": {
"expect": [
{
"name": "retry",
"type": "boolean",
"label": "Automatically complete execution",
"required": true
},
{
"name": "count",
"type": "uinteger",
"label": "Number of attempts",
"required": true
},
{
"name": "interval",
"type": "uinteger",
"label": "Interval between attempts",
"required": true
}
],
"restore": {
"retry": {
"mode": "chose"
}
},
"designer": {
"x": 300,
"y": 0
}
},
"parameters": {}
}
],
"version": 3,
"metadata": {
"expect": [
{
"name": "url",
"type": "url",
"label": "URL",
"required": true
},
{
"name": "method",
"type": "select",
"label": "Method",
"required": true,
"validate": {
"enum": [
"get",
"head",
"post",
"put",
"patch",
"delete"
]
}
},
{
"name": "headers",
"spec": [
{
"name": "name",
"type": "text",
"label": "Name",
"required": true
},
{
"name": "value",
"type": "text",
"label": "Value"
}
],
"type": "array",
"label": "Headers",
"labels": {
"add": "Add a header",
"edit": "Edit a header"
}
},
{
"name": "qs",
"spec": [
{
"name": "name",
"type": "text",
"label": "Name",
"required": true
},
{
"name": "value",
"type": "text",
"label": "Value"
}
],
"type": "array",
"label": "Query String",
"labels": {
"add": "Add parameter",
"edit": "Edit parameter"
}
},
{
"name": "bodyType",
"type": "select",
"label": "Body type",
"validate": {
"enum": [
"raw",
"x_www_form_urlencoded",
"multipart_form_data"
]
}
},
{
"name": "parseResponse",
"type": "boolean",
"label": "Parse response",
"required": true
},
{
"name": "authUser",
"type": "text",
"label": "User name"
},
{
"name": "authPass",
"type": "password",
"label": "Password"
},
{
"name": "timeout",
"type": "uinteger",
"label": "Timeout",
"validate": {
"max": 300,
"min": 1
}
},
{
"name": "shareCookies",
"type": "boolean",
"label": "Share cookies with other HTTP modules",
"required": true
},
{
"name": "ca",
"type": "cert",
"label": "Self-signed certificate",
"multiline": true
},
{
"name": "rejectUnauthorized",
"type": "boolean",
"label": "Reject connections that are using unverified (self-signed) certificates",
"required": true
},
{
"name": "followRedirect",
"type": "boolean",
"label": "Follow redirect",
"required": true
},
{
"name": "useQuerystring",
"type": "boolean",
"label": "Disable serialization of multiple same query string keys as arrays",
"required": true
},
{
"name": "gzip",
"type": "boolean",
"label": "Request compressed content",
"required": true
}
],
"restore": {
"qs": {
"mode": "chose",
"items": []
},
"method": {
"mode": "chose",
"label": "GET"
},
"headers": {
"mode": "chose",
"items": []
},
"bodyType": {
"label": ""
}
},
"designer": {
"x": 0,
"y": 0
},
"parameters": [
{
"name": "handleErrors",
"type": "boolean",
"label": "Evaluate all states as errors (except for 2xx and 3xx )",
"required": true
}
]
},
"parameters": {
"handleErrors": false
}
}
],
"name": "Integration of failing scenario",
"metadata": {
"user": {
"id": 1
},
"version": 1,
"scenario": {
"maxErrors": 3,
"autoCommit": true,
"roundtrips": 1
}
}
},
"company": 1,
"idSequence": 3,
"reason": "IP address is not valid."
}
}Gets bundles that caused the incomplete execution.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5GET /api/v2/dlqs/{dlqId}/bundle HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"code": "OK",
"response": {
"1": {
"error": {
"type": "InvalidConfigurationError",
"message": "IP address is not valid."
}
},
"3": {
"value": "Example error text."
}
}
}Gets data about attempts to resolve an incomplete execution.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5The status number of the incomplete execution. The status numbers correspond to the following statuses:
- 1: success,
- 2: warning,
- 3: error.
3Possible values: The moment from which you want to list the incomplete execution logs. The timestamp is in the UNIX timestamp format.
1548975600000Limits the returned incomplete execution logs to those that were created before the specified moment. The timestamp is in the UNIX timestamp format.
1574782119387GET /api/v2/dlqs/{dlqId}/logs HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"dlqLogs": [
{
"imtId": "1574777797796_dlq.a07e16f2ad134bf49cf83a00aa95c0a5.manual.f241ee9b0d344964a5ce54356b9ed98e",
"duration": 728,
"transfer": 0,
"operations": 1,
"teamId": 1,
"id": "f241ee9b0d344964a5ce54356b9ed98e",
"type": "manual",
"authorId": null,
"timestamp": "2019-11-26T14:16:37.796Z",
"status": 3
},
{
"imtId": "1574777795371_dlq.a07e16f2ad134bf49cf83a00aa95c0a5.manual.7f65bad83eb74c899a70c76794d8afc3",
"duration": 795,
"transfer": 0,
"operations": 1,
"teamId": 1,
"id": "7f65bad83eb74c899a70c76794d8afc3",
"type": "manual",
"authorId": null,
"timestamp": "2019-11-26T14:16:35.371Z",
"status": 3
}
],
"pg": {
"sortBy": "imtId",
"sortDir": "desc",
"limit": 50,
"offset": 0
}
}Gets detail of the specified incomplete execution log.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5The ID of the incomplete execution log. Get the ID values of the incomplete execution logs with the API call GET /dlqs/{dlqId}/logs.
1356b72d781649a18692a0d4d09cd977GET /api/v2/dlqs/{dlqId}/logs/{executionDlqId} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"dlqLog": {
"imtId": "1594117724361_dlq.00946714d6dd4a4cb091fe5435a8d197.manual.28a4794e85894c80a483777d6958160f",
"duration": 1353,
"operations": 1,
"transfer": 87,
"organizationId": 1,
"teamId": 1,
"id": "28a4794e85894c80a483777d6958160f",
"type": "manual",
"authorId": null,
"instant": false,
"timestamp": "2020-07-07T10:28:44.361Z",
"status": 3
}
}Triggers a retry of the specified incomplete execution. The incomplete execution runs with the blueprint from when the error happened.
If you need to update the blueprint first, use the endpoint PATCH /dlqs/{dlqId}.
The ID of the incomplete execution. Get the ID values of the incomplete executions of a scenario with the API call GET /dlqs?scenarioId={scenarioId}.
a07e16f2ad134bf49cf83a00aa95c0a5POST /api/v2/dlqs/{dlqId}/retry HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
Successful response
{
"dlq": "a07e16f2ad134bf49cf83a00aa95c0a5"
}Triggers a retry of the specified incomplete executions. You can either use the all parameter to retry all incomplete executions of the scenario, or specify a list of incomplete execution IDs in the ids property.
You can use the exceptIds parameter to exclude incomplete executions from retrying.
The incomplete executions run with the blueprint from when the error happened. If you need to update the blueprint first, use the endpoint PATCH /dlqs/{dlqId}.
Make puts the incomplete executions in a queue. If you are retrying a large number of incomplete executions, there might be a delay between receiving the response and Make retrying the incomplete execution.
The ID of the scenario. You can get the scenarioId with the List scenarios API call.
112The list of incomplete execution IDs you want to retry. All of the IDs have to belong to the same scenario.
Set to true to retry all incomplete executions of the scenario.
You can use this parameter together with the all parameter to specify incomplete execution IDs which shouldn't be retried.
POST /api/v2/dlqs/retry HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79
{
"ids": [
"a07e16f2ad134bf49cf83a00aa95c0a5",
"mvrij98emciefm98cmemf345an18e8q3"
]
}Successful response
{
"dlqs": [
"a07e16f2ad134bf49cf83a00aa95c0a5",
"mvrij98emciefm98cmemf345an18e8q3"
]
}