Notification API Reference
API Reference/Notification

Notification

For authentication instructions, see API overview.

Endpoints

get/api/v2/notification-setups
post/api/v2/notification-setups
get/api/v2/notification-setups/:id
put/api/v2/notification-setups/:id
patch/api/v2/notification-setups/:id
delete/api/v2/notification-setups/deleted/:id
get

List all notification setups

Returns a list of notification setups. The notification setups are returned in sorted order, with the most recent appearing first.

Query parameters

  • limitinteger

    The number of records to return

  • pageinteger

    The page number

  • orderstring

    The order of the records

  • sortBystring

    The sort of the records

  • fieldsstring

    The filter of the records

  • pstring

    policyFilters

  • qstring

    search query

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notification-setups

Response

No response schema
post

Create notification setups

Create notification setups. You need to pass through any required fields, and you can optionally pass through other fields.

Request body

  • titlestring
  • codestring
  • objectstring
  • actionstring
  • querystring
  • triggerFieldstring
  • messagestring
  • subjectstring
  • typestring
  • frequencystring
  • daystring
  • timestring
  • channelsarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X POST -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notification-setups \
	-d 'title="test"' \
	-d 'code="asdfsdf"' \
	-d 'object="tasks"' \
	-d 'action="query"' \
	-d 'query="query=new"' \
	-d 'triggerField="status"' \
	-d 'message="test"' \
	-d 'subject="test"' \
	-d 'type="instant"' \
	-d 'frequency="daily"' \
	-d 'day="null"' \
	-d 'time="null"' \
	-d 'channels="array"'

Response

No response schema
get

Retrieve notification setups

Returns a single notification setup, which you can request by passing through an id in the url.

Path parameters

  • idstring

    ID of the notification setup

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notification-setups/:id

Response

No response schema
put

Update notification setups

Path parameters

  • idstring

    ID of the notification setup

Request body

  • titlestring
  • codestring
  • objectstring
  • actionstring
  • querystring
  • triggerFieldstring
  • messagestring
  • subjectstring
  • typestring
  • frequencystring
  • daystring
  • timestring
  • channelsarray

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X PUT \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notification-setups/:id \
	-d 'title="test"' \
	-d 'code="asdfsdf"' \
	-d 'object="tasks"' \
	-d 'action="query"' \
	-d 'query="query=new"' \
	-d 'triggerField="status"' \
	-d 'message="test"' \
	-d 'subject="test"' \
	-d 'type="instant"' \
	-d 'frequency="daily"' \
	-d 'day="null"' \
	-d 'time="null"' \
	-d 'channels="array"'

Response

No response schema
patch

Update notification setups soft

Update notification setups soft by setting the values of the parameters passed. Any parameters not set will be unchanged.

Path parameters

  • idstring

    ID of the notification setup

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notification-setups/:id

Response

No response schema
delete

Delete notification setups

Path parameters

  • idstring

    ID of the notification setup

Request

cURL
export ICLOUDREADY_API_KEY=[your api key]
curl -X DELETE \
    -H "Authorization: Bearer $ICLOUDREADY_API_KEY" \
    https://api.icloud-ready.com/api/v2/notification-setups/deleted/:id

Response

No response schema