Delete items from webhook queue

Required scopes:

• hooks:write

Deletes items from the processing queue of the specified webhook. Specify the payload ID values that you want to delete in the request body in the ids array.

You can set the "all": true pair to delete all items from the webhook processing queue. 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.

The API call response will contain an error message if some of the specified queue items cannot be deleted. The rest of the specified items will be deleted. Deleting a webhook queue item is not allowed when the item is already being processed by the webhook.

DELETEhttps://eu1.make.com/api/v2/hooks/{hookId}/incomings

Authorization

token

Path parameters

hookId*integer

The ID of the webhook. Use the GET /hooks API call to get the ID values of your webhooks.

Example: 654

Query parameters

Body

application/json

idsarray of string

The ID values of the webhook processing queue items that you want to delete. Use the API call GET /hooks/{hookId}/incomings to get the ID values of the webhook processing queue items.

exceptIdsarray of string

If you are deleting all of the incomplete executions with the all:true parameter, you can specify the ID values of the webhook queue items that you want to keep. Use the API call GET /hooks/{hookId}/incomings to get the ID values of the webhook queue items.

allboolean

Set to true to delete all items in the webhook processing queue.

Response

200

Successful response

Body

application/json

incomingsarray of string

errorobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('https://eu1.make.com/api/v2/hooks/{hookId}/incomings', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ids": [
        "d1efa5318a034d36ad7cbeac543573cf",
        "29d9a7410dff494ab739036f6c332335"
      ],
      "exceptIds": [],
      "all": false
    }),
});
const data = await response.json();

Response

200

{
  "incomings": [
    "text"
  ],
  "error": {
    "name": "text",
    "message": "text"
  }
}