Ctrlk
SaaSBook a demoStatus page
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notification

APIs for managing notifications

Get user preferences

get

Get the user preferences for notifications

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
application/json
providerstringRequired
enabledbooleanRequired
get/api/notification/user-preferences
GET /marketplace/api/notification/user-preferences HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "provider": "text",
    "enabled": true,
    "typePreferences": [
      {
        "notificationType": "text",
        "enabled": true
      }
    ],
    "metadata": {
      "authVerified": true,
      "teamsStoreUrl": "https://example.com"
    }
  }
]

Update user preferences

put

Update the user preferences for notifications

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200Success
application/json
recipientIdstring · uuidRequired
put/api/notification/user-preferences
PUT /marketplace/api/notification/user-preferences HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "preferences": [
    {
      "provider": "text",
      "typePreferences": [
        {
          "notificationType": "text",
          "enabled": true
        }
      ]
    }
  ]
}
200Success
{
  "recipientId": "123e4567-e89b-12d3-a456-426614174000",
  "preferences": [
    {
      "provider": "text",
      "typePreferences": [
        {
          "notificationType": "text",
          "enabled": true
        }
      ]
    }
  ]
}
put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200Success
application/json
recipientIdstring · uuidRequired
put/api/notification/user-provider-configs
PUT /marketplace/api/notification/user-provider-configs HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "configs": [
    {
      "provider": "text",
      "enabled": true
    }
  ]
}
200Success
{
  "recipientId": "123e4567-e89b-12d3-a456-426614174000",
  "configs": [
    {
      "provider": "text",
      "enabled": true
    }
  ]
}

Get inbox messages

get

Get a list of inbox messages for the current user, with optional filters for read status.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
readbooleanOptional
Responses
200Success
application/json
get/api/notification/inbox/messages
GET /marketplace/api/notification/inbox/messages HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "notificationId": "123e4567-e89b-12d3-a456-426614174000",
      "notificationType": "text",
      "message": "text",
      "subject": "text",
      "createdAt": "2025-01-09T12:34:56.000Z",
      "readAt": "2025-01-09T12:34:56.000Z",
      "data": {
        "actionLink": "https://example.com"
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Get inbox message by ID

get

Get the details of a specific inbox message by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json
idstring · uuidRequired
notificationIdstring · uuidRequired
notificationTypestringRequired
messagestringRequired
subjectstringRequired
createdAtstring · iso_formatRequiredExample: 2025-01-09T12:34:56.000Z
readAtstring · iso_formatOptionalExample: 2025-01-09T12:34:56.000Z
get/api/notification/inbox/messages/{id}
GET /marketplace/api/notification/inbox/messages/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "notificationId": "123e4567-e89b-12d3-a456-426614174000",
  "notificationType": "text",
  "message": "text",
  "subject": "text",
  "createdAt": "2025-01-09T12:34:56.000Z",
  "readAt": "2025-01-09T12:34:56.000Z",
  "data": {
    "actionLink": "https://example.com"
  }
}

Set inbox message read status

patch

Update the read status of a specific inbox message by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
readbooleanRequired
Responses
200Success
application/json
idstring · uuidRequired
notificationIdstring · uuidRequired
notificationTypestringRequired
messagestringRequired
subjectstringRequired
createdAtstring · iso_formatRequiredExample: 2025-01-09T12:34:56.000Z
readAtstring · iso_formatOptionalExample: 2025-01-09T12:34:56.000Z
patch/api/notification/inbox/messages/{id}
PATCH /marketplace/api/notification/inbox/messages/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 13

{
  "read": true
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "notificationId": "123e4567-e89b-12d3-a456-426614174000",
  "notificationType": "text",
  "message": "text",
  "subject": "text",
  "createdAt": "2025-01-09T12:34:56.000Z",
  "readAt": "2025-01-09T12:34:56.000Z",
  "data": {
    "actionLink": "https://example.com"
  }
}

Bulk update inbox message read status

patch

Update the read status of multiple inbox messages by their IDs.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject[]
idstring · uuidRequired
readbooleanRequired
Responses
200Success
application/json
idstring · uuidRequired
notificationIdstring · uuidRequired
notificationTypestringRequired
messagestringRequired
subjectstringRequired
createdAtstring · iso_formatRequiredExample: 2025-01-09T12:34:56.000Z
readAtstring · iso_formatOptionalExample: 2025-01-09T12:34:56.000Z
patch/api/notification/inbox/messages/update-bulk
PATCH /marketplace/api/notification/inbox/messages/update-bulk HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "read": true
  }
]
200Success
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "notificationId": "123e4567-e89b-12d3-a456-426614174000",
    "notificationType": "text",
    "message": "text",
    "subject": "text",
    "createdAt": "2025-01-09T12:34:56.000Z",
    "readAt": "2025-01-09T12:34:56.000Z",
    "data": {
      "actionLink": "https://example.com"
    }
  }
]

Get webhooks

get

Get a list of webhooks.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
application/json
idstring · uuidRequired
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeybooleanOptionalDefault: false
suppressedbooleanOptionalDefault: false
get/api/notification/webhook
GET /marketplace/api/notification/webhook HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "url": "https://example.com",
    "verifyTls": true,
    "signingKey": false,
    "suppressed": false
  }
]

Create webhook

post

Create a new webhook.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeystringOptional
Responses
200Success
application/json
idstring · uuidRequired
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeybooleanOptionalDefault: false
suppressedbooleanOptionalDefault: false
post/api/notification/webhook
POST /marketplace/api/notification/webhook HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": false,
  "suppressed": false
}

Get webhook by ID

get

Get the details of a specific webhook by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json
idstring · uuidRequired
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeybooleanOptionalDefault: false
suppressedbooleanOptionalDefault: false
get/api/notification/webhook/{id}
GET /marketplace/api/notification/webhook/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": false,
  "suppressed": false
}

Update webhook

put

Update the details of a specific webhook by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Body
urlstring · uriOptional
verifyTlsbooleanOptionalDefault: true
signingKeystringOptional
Responses
200Success
application/json
idstring · uuidRequired
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeybooleanOptionalDefault: false
suppressedbooleanOptionalDefault: false
put/api/notification/webhook/{id}
PUT /marketplace/api/notification/webhook/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": false,
  "suppressed": false
}

Delete webhook

delete

Delete a specific webhook by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
204Success
No content
delete/api/notification/webhook/{id}
DELETE /marketplace/api/notification/webhook/{id} HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204Success
No content

Get webhook history

get

Get the history of a specific webhook by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Query parameters
offsetnumberOptionalDefault: 0
limitnumber · min: 1OptionalDefault: 10
Responses
200Success
application/json
get/api/notification/webhook/{id}/history
GET /marketplace/api/notification/webhook/{id}/history HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "data": [
    {
      "webhookId": "123e4567-e89b-12d3-a456-426614174000",
      "deliveryId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "httpStatusCode": 1,
      "createdAt": "2025-01-09T12:34:56.000Z",
      "message": "text"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 10,
    "totalCount": 1,
    "pageCount": 1,
    "currentPage": 1,
    "totalPages": 1
  }
}

Test webhook

post

Test a specific webhook by ID.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idstringRequired
Responses
200Success
application/json
statusstring · enumRequiredPossible values:
httpStatusCodenumberRequired
errorMessagestringOptional
post/api/notification/webhook/{id}/test
POST /marketplace/api/notification/webhook/{id}/test HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "status": "UNSPECIFIED",
  "httpStatusCode": 1,
  "errorMessage": "text"
}

Test webhook configuration

post

Test all webhook configurations.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
urlstring · uriRequired
verifyTlsbooleanOptionalDefault: true
signingKeystringOptional
Responses
200Success
application/json
statusstring · enumRequiredPossible values:
httpStatusCodenumberRequired
errorMessagestringOptional
post/api/notification/webhook/test
POST /marketplace/api/notification/webhook/test HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "url": "https://example.com",
  "verifyTls": true,
  "signingKey": "text"
}
200Success
{
  "status": "UNSPECIFIED",
  "httpStatusCode": 1,
  "errorMessage": "text"
}

Get Slack notifications configuration

get

Get the Slack notifications configuration.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
application/json
isConfiguredbooleanRequired
get/api/notification/slack/configuration
GET /marketplace/api/notification/slack/configuration HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "isConfigured": true,
  "configuration": {
    "teamName": "text",
    "teamId": "text",
    "botUserId": "text",
    "enterpriseName": "text",
    "enterpriseId": "text"
  }
}

Delete Slack notifications configuration

delete

Delete the Slack notifications configuration.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
No content
delete/api/notification/slack/configuration
DELETE /marketplace/api/notification/slack/configuration HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
No content

Test Slack notifications configuration

get

Test the Slack notifications configuration.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Responses
200Success
application/json
isValidbooleanRequired
errorMessagestringOptional
get/api/notification/slack/test
GET /marketplace/api/notification/slack/test HTTP/1.1
Host: na.api.immutacloud.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Success
{
  "isValid": true,
  "errorMessage": "text"
}
PreviousMetadata
NextSettings

Last updated

Was this helpful?