Notifications

The Notifications feature keeps you informed about problems in your scenarios and keep you up to date when it comes to the new features and improvements in Make. The following endpoints allow you to manage the notifications.

List notifications

get

/notifications

Retrieves a collection of all notifications for the authenticated user. Returned notifications are sorted by ID in descending order.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

unreadOnlybooleanOptional

If set to true, this parameter returns only the unread notifications.

Example: false

imtZoneIdintegerOptional

The unique ID of the Make zone. This parameter is required to retrieve notifications from the Make version. For other Make platforms, it can be ignored. The IDs of the zones can be obtained from the /enums/imt-zones endpoint.

Example: 2

pg[sortBy]string · enumOptional

The value that will be used to sort returned entities by. Notifications can be currently sorted only by ID.

Possible values:

pg[offset]integerOptional

The value of entities you want to skip before getting entities you need.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:

pg[limit]integerOptional

Sets the maximum number of results per page in the API call response. For example, pg[limit]=100. The default number varies with different API endpoints.

Responses

200

Successful response

application/json

get

/notifications

GET /api/v2/notifications HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "notifications": [
    {
      "id": "3",
      "subject": "Encountered error in Integration HTTP scenario",
      "read": "2021-05-14T11:35:22.837Z",
      "created": "2021-05-14T11:18:43.340Z",
      "type": 1
    },
    {
      "id": "2",
      "subject": "Encountered error in Integration HTTP scenario",
      "read": null,
      "created": "2021-05-14T11:17:04.433Z",
      "type": 1
    },
    {
      "id": "1",
      "subject": "Encountered error in Integration HTTP scenario",
      "read": null,
      "created": "2021-05-14T11:14:08.675Z",
      "type": 1
    }
  ],
  "userUnreadNotifications": 4,
  "userZoneNotifications": [
    {
      "imtZoneId": 1,
      "unreadNotifications": 4
    }
  ],
  "pg": {
    "sortBy": "id",
    "limit": 10000,
    "sortDir": "desc",
    "offset": 0
  }
}

Delete notifications

delete

/notifications

Deletes notifications with given IDs and returns their IDs in the response. This endpoint allows deleting one or more notifications at once.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

imtZoneIdintegerOptional

Example: 2

Body

idsstring[]Required

The array with IDs of the notifications to delete. Since the number of notifications can reach a BigInt and because of the limitations of the Open API format, the IDs need to be strings.

Responses

200

Successful response

application/json

delete

/notifications

DELETE /api/v2/notifications HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "ids": [
    "1",
    "2",
    "3"
  ]
}

200

Successful response

{
  "notifications": [
    {
      "id": "1"
    },
    {
      "id": "2"
    }
  ]
}

Get notification detail

get

/notifications/{notificationId}

Retrieves details and full content of a notification with a given ID.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

notificationIdstringRequired

The unique ID of the notification. It can be retrieved from the List notifications endpoint. Since the number of notifications can reach a BigInt and because of the limitations of the Open API format, the IDs need to be strings.

Example: 3

Query parameters

imtZoneIdintegerOptional

Example: 2

Responses

200

Successful response

application/json

get

/notifications/{notificationId}

GET /api/v2/notifications/{notificationId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "notification": {
    "id": "3",
    "subject": "Encountered error in Integration HTTP 3 scenario",
    "read": "2020-02-29T21:20:40.093Z",
    "created": "2020-01-22T13:54:29.748Z",
    "type": 1,
    "body": "<p>Your scenario <strong>Integration HTTP 3</strong> has encountered an error.</p>\n<p>The scenario has not been paused and continues to run according to your settings. Nevertheless, you should pay attention to the issue.</p>\n<ul>\n<li>Scenario: <a href=\"https://local.make.cloud/scenario/86/log\">Integration HTTP 3</a></li>\n<li>Organization: <a href=\"https://local.make.cloud/organization/2\">test team</a></li>\n<li>Team: <a href=\"https://local.make.cloud/team/1\">My Lab</a></li>\n<li>Execution: <a href=\"https://local.make.cloud/scenario/86/log/d4f49055d5f44705b2aaf77a09547b77\">d4f49055d5f44705b2aaf77a09547b77</a></li>\n</ul>\n<p>Details:</p>\n<ul>\n<li><code>Validation failed for 1 parameter(s).</code></li>\n<li><code>Missing value of required parameter &#39;{{!expect.json.label}}&#39;.</code></li>\n</ul>\n<p>If you have questions or need help, please contact us.</p>\n"
  }
}

Mark all notifications as read

post

/notifications/mark-as-read

Marks all notifications as read and returns the IDs of the updated notifications in the response.

Required scopes

This endpoint requires the following scopes:

Authorizations

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

idsstringOptional

Forces the request to mark all notifications as read. This parameter can only have the all value.

imtZoneIdintegerOptional

Example: 2

Responses

200

Successful response

application/json

post

/notifications/mark-as-read

POST /api/v2/notifications/mark-as-read HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "notifications": [
    {
      "id": "1"
    },
    {
      "id": "2"
    },
    {
      "id": "3"
    },
    {
      "id": "4"
    },
    {
      "id": "5"
    }
  ]
}

PreviousKeys NextOrganizations

Last updated 6 days ago