Notification API Reference
API Reference/Notification

Notification

For authentication instructions, see API overview.

Endpoints

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

List all notification signals

Returns a list of notification signals. The notification signals 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-signals

Response

No response schema
post

Create notification signals

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

Request body

  • signalNumbernumber
  • userIdarray
  • messagestring
  • subjectstring
  • notificationTitlestring
  • notifiedUserarray
  • objectstring
  • objectIdstring
  • datestring
  • 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-signals \
	-d 'signalNumber=1' \
	-d 'userId="array"' \
	-d 'message="signal1"' \
	-d 'subject="description1"' \
	-d 'notificationTitle="description1"' \
	-d 'notifiedUser="array"' \
	-d 'object="leads"' \
	-d 'objectId="658d76e77cbaea0018df3de8"' \
	-d 'date="2023-04-19"' \
	-d 'time="2023-04-19"' \
	-d 'channels="array"'

Response

No response schema
get

Retrieve notification signals

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

Path parameters

  • idstring

    ID of the notification signal

Request

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

Response

No response schema
put

Update notification signals

Path parameters

  • idstring

    ID of the notification signal

Request body

  • signalNumbernumber
  • userIdarray
  • messagestring
  • subjectstring
  • notificationTitlestring
  • notifiedUserarray
  • objectstring
  • objectIdstring
  • datestring
  • 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-signals/:id \
	-d 'signalNumber=1' \
	-d 'userId="array"' \
	-d 'message="signal1"' \
	-d 'subject="description1"' \
	-d 'notificationTitle="description1"' \
	-d 'notifiedUser="array"' \
	-d 'object="leads"' \
	-d 'objectId="658d76e77cbaea0018df3de8"' \
	-d 'date="2023-04-19"' \
	-d 'time="2023-04-19"' \
	-d 'channels="array"'

Response

No response schema
patch

Update notification signals soft

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

Path parameters

  • idstring

    ID of the notification signal

Request

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

Response

No response schema
delete

Delete notification signals

Path parameters

  • idstring

    ID of the notification signal

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-signals/deleted/:id

Response

No response schema
post

Create notification signals

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

Path parameters

  • idstring

    ID of the notification signal

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-signals/channel/:id

Response

No response schema