Skip to content

Click in-app to access the full platform documentation for your version of DataRobot.

Notifications

This page outlines the operations, endpoints, parameters, and example requests and responses for the Notifications.

GET /api/v2/notificationChannels/

List the notification channels according to the query.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationChannels/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true How many notification channels to skip.
limit query integer true At most this many notification channels to return.
namePart query string false Only return the notification channels whose names contain the given substring.

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "channelType": "Webhook",
      "contentType": "application/x-www-form-urlencoded",
      "createdAt": "2019-08-24T14:15:22Z",
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "secretToken": "string",
      "uid": "string",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Notification channels listed successfully. NotificationChannelsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notificationChannels/

Create a new notification channel.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notificationChannels/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name In Type Required Description
body body NotificationChannelCreate false none

Example responses

201 Response

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "secretToken": "string",
  "uid": "string",
  "validateSsl": true
}

Responses

Status Meaning Description Schema
201 Created Notification channel created successfully. NotificationChannelResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/notificationChannels/{channelId}/

Delete the notification channel.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/notificationChannels/{channelId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
channelId path string true The id of the notification channel.

Responses

Status Meaning Description Schema
204 No Content Notification channel deleted successfully. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationChannels/{channelId}/

Retrieve the notification channel.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationChannels/{channelId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
channelId path string true The id of the notification channel.

Example responses

200 Response

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "secretToken": "string",
  "uid": "string",
  "validateSsl": true
}

Responses

Status Meaning Description Schema
200 OK Notification channel retrieved successfully. NotificationChannelResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/notificationChannels/{channelId}/

Update the notification channel.

Code samples

# You can also use wget
curl -X PUT http://10.97.111.38/api/v2/notificationChannels/{channelId}/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "contentType": "application/x-www-form-urlencoded",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Parameters

Name In Type Required Description
channelId path string true The id of the notification channel.
body body NotificationChannelUpdate false none

Responses

Status Meaning Description Schema
204 No Content Notification channel updated successfully. None
400 Bad Request Email verification code is invalid. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notificationEmailChannelVerification/

Sending a 6 digit verification code to user's email

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notificationEmailChannelVerification/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "channelType": "string",
  "emailAddress": "string",
  "name": "string",
  "orgId": "string"
}

Parameters

Name In Type Required Description
body body NotificationEmailChannelVerification false none

Example responses

200 Response

{
  "notificationId": "string"
}

Responses

Status Meaning Description Schema
200 OK none NotificationEmailChannelVerificationResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notificationEmailChannelVerificationStatus/

Retrieve the status of whether admin enter code correctly

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notificationEmailChannelVerificationStatus/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "emailAddress": "string",
  "verificationCode": "string"
}

Parameters

Name In Type Required Description
body body NotificationEmailChannelVerificationStatus false none

Example responses

200 Response

{
  "status": true
}

Responses

Status Meaning Description Schema
200 OK none NotificationEmailChannelVerificationStatusResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationEvents/

List event types and groups the user can include in notification policies. Events and groups are filtered by user permissions and event properties. It is not a complete list of all defined events; instead, it is a list of the events available to the user.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationEvents/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Example responses

200 Response

{
  "eventGroups": [
    {
      "events": [
        "string"
      ],
      "id": "string",
      "label": "string"
    }
  ],
  "events": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Event types and groups selectable for notification policies NotificationEventListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationLogs/

List the notification logs that correspond to provided conditions. Default ordering is desc by notification log timestamp

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationLogs/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true The number of records to skip over. Default 0
limit query integer true The number of records to return. Default to 100, minimum to 1, maximum to 1000
policyId query string false The id of the policy to filter notification logs
channelId query string false The id of the channel to filter notification logs

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "channelId": "string",
      "emailSubject": "string",
      "id": "string",
      "parentNotificationId": "string",
      "policyId": "string",
      "request": {
        "body": "string",
        "headers": "string",
        "url": "http://example.com"
      },
      "response": {
        "body": "string",
        "duration": 0,
        "headers": "string",
        "statusCode": "string"
      },
      "retryCount": 0,
      "status": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none NotificationLogListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationPolicies/

List the notification policies that satisfy the query condition.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationPolicies/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true How many notification channels to skip.
limit query integer true At most this many notification channels to return.
channelId query string false Return policies with this channel.
namePart query string false Only return the notification channels whose names contain the given substring.
eventGroup query string false Return policies with this event group.

Enumerated Values

Parameter Value
eventGroup dataset.all
eventGroup project.all
eventGroup model_deployments.critical_health
eventGroup model_deployments.health
eventGroup model_deployments.management_agent
eventGroup model_deployments.management_agent_health
eventGroup prediction_request.all
eventGroup challenger_management.all
eventGroup challenger_replay.all
eventGroup model_deployments.all
eventGroup comment.all
eventGroup perma_delete_project.all
eventGroup users_delete.all
eventGroup batch_predictions.all
eventGroup applications.all
eventGroup change_requests.all
eventGroup monitoring.all

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "Webhook",
        "contentType": "application/x-www-form-urlencoded",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "secretToken": "string",
        "uid": "string",
        "validateSsl": true
      },
      "channelId": "string",
      "created": "2019-08-24T14:15:22Z",
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "uid": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK Notification policies listed successfully. NotificationPoliciesListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notificationPolicies/

Create a new notification policy.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notificationPolicies/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "active": true,
  "channelId": "string",
  "eventGroup": "dataset.all",
  "eventType": "dataset.created",
  "name": "string",
  "orgId": "string"
}

Parameters

Name In Type Required Description
body body NotificationPolicyCreate false none

Example responses

201 Response

{
  "active": true,
  "channel": {
    "channelType": "Webhook",
    "contentType": "application/x-www-form-urlencoded",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "secretToken": "string",
    "uid": "string",
    "validateSsl": true
  },
  "channelId": "string",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "uid": "string"
}

Responses

Status Meaning Description Schema
201 Created Notification policy created successfully. NotificationPolicyResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/notificationPolicies/{policyId}/

Delete the notification policy.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/notificationPolicies/{policyId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
policyId path string true The id of the notification policy

Responses

Status Meaning Description Schema
204 No Content Notification policy deleted successfully. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationPolicies/{policyId}/

Retrieve the notification policy.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationPolicies/{policyId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
policyId path string true The id of the notification policy

Example responses

200 Response

{
  "active": true,
  "channel": {
    "channelType": "Webhook",
    "contentType": "application/x-www-form-urlencoded",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "secretToken": "string",
    "uid": "string",
    "validateSsl": true
  },
  "channelId": "string",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "uid": "string"
}

Responses

Status Meaning Description Schema
200 OK Notification policy retrieved successfully. NotificationPolicyResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/notificationPolicies/{policyId}/

Update the notification policy.

Code samples

# You can also use wget
curl -X PUT http://10.97.111.38/api/v2/notificationPolicies/{policyId}/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "active": true,
  "channelId": "string",
  "eventGroup": "dataset.all",
  "eventType": "dataset.created",
  "name": "string"
}

Parameters

Name In Type Required Description
policyId path string true The id of the notification policy
body body NotificationPolicyUpdate false none

Responses

Status Meaning Description Schema
204 No Content Notification policy updated successfully. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationPolicyMutes/

List the ignored notifications filtered by orgId if provided

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationPolicyMutes/?offset=0&limit=100 \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer true The number of records to skip over. Default 0
limit query integer true The number of records to return. Default to 100, minimum to 1, maximum to 1000
entityId query string false The id of the entity to filter
orgId query string false The id of the organization that ignored notifications relate to

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "entityId": "string",
      "id": "string",
      "policyId": "string",
      "uid": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK none NotificationPolicyMuteListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notificationPolicyMutes/

Create a new ignored notification

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notificationPolicyMutes/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "entityId": "string",
  "policyId": "string"
}

Parameters

Name In Type Required Description
body body NotificationPolicyMuteCreate false none

Example responses

200 Response

{
  "entityId": "string",
  "id": "string",
  "policyId": "string",
  "uid": "string"
}

Responses

Status Meaning Description Schema
200 OK none NotificationPolicyMuteResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/notificationPolicyMutes/{muteId}/

Delete the existing notification policy mute

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/notificationPolicyMutes/{muteId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
muteId path string true The id of the notification policy mute to delete

Responses

Status Meaning Description Schema
200 OK none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notificationWebhookChannelTests/

Test the webhook notification channel.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notificationWebhookChannelTests/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true
}

Parameters

Name In Type Required Description
body body NotificationWebhookChannelTestCreate false none

Example responses

201 Response

{
  "notificationId": "string"
}

Responses

Status Meaning Description Schema
201 Created The test for the webhook notification channel was created. NotificationWebhookChannelTestId

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/notificationWebhookChannelTests/{notificationId}/

Retrieve the status of the notification channel test.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/notificationWebhookChannelTests/{notificationId}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
notificationId path string true The identifier of the notification.

Example responses

200 Response

{
  "notificationLog": {
    "channelId": "string",
    "emailSubject": "string",
    "id": "string",
    "parentNotificationId": "string",
    "policyId": "string",
    "request": "string",
    "response": "string",
    "retryCount": 0,
    "status": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "status": "string"
}

Responses

Status Meaning Description Schema
200 OK The notification status was retrieved. NotificationWebhookChannelStatusResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/notifications/

Resends the notification

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/notifications/ \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "notificationId": "string"
}

Parameters

Name In Type Required Description
body body NotificationResend false none

Responses

Status Meaning Description Schema
200 OK none None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/remoteEvents/

Post an event from a remote deployment.

Code samples

# You can also use wget
curl -X POST http://10.97.111.38/api/v2/remoteEvents/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "data": {
    "newModelId": "string",
    "oldModelId": "string",
    "reason": "string"
  },
  "deploymentId": "string",
  "eventType": "spoolerChannelGreen",
  "message": "string",
  "orgId": "string",
  "predictionEnvironmentId": "string",
  "predictionRequestData": {
    "error_code": "string",
    "model_id": "string",
    "response_body": "string",
    "status_code": 0,
    "user_id": "string"
  },
  "spoolerChannelData": {
    "name": "string",
    "type": "asyncMemory"
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

Parameters

Name In Type Required Description
body body RemoteEventCreate false none

Example responses

201 Response

{
  "message": "string"
}

Responses

Status Meaning Description Schema
201 Created The event was created. CreateRemoteEventResponse
404 Not Found The deployment was not found. None
422 Unprocessable Entity Unable to process the request instructions or failed to post the event. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/userNotifications/

Delete all notifications associated with the user.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/userNotifications/ \
  -H 'Authorization: Bearer {access-token}'

Responses

Status Meaning Description Schema
204 No Content Notifications were deleted. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/userNotifications/

Returns list of user's notifications from latest to oldest.

Code samples

# You can also use wget
curl -X GET http://10.97.111.38/api/v2/userNotifications/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
offset query integer false The number of records to skip over
limit query integer false The number of records to return
isRead query boolean false When provided, returns only read or unread notifications

Example responses

200 Response

{
  "count": 0,
  "data": [
    {
      "callerUser": {
        "fullName": "string",
        "gravatarHash": "string",
        "inactive": true,
        "uid": "string",
        "username": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "eventType": "autopilot.complete",
      "isRead": true,
      "link": "string",
      "pushNotificationSent": true,
      "relatedComment": {
        "commentId": "string",
        "commentLink": "string",
        "entityId": "string",
        "entityType": "useCase",
        "inactive": true
      },
      "relatedDeployment": {
        "deploymentId": "string",
        "deploymentName": "string",
        "deploymentUrl": "string",
        "inactive": true,
        "modelId": "string",
        "projectId": "string",
        "userId": "string"
      },
      "relatedProject": {
        "inactive": true,
        "pid": "string",
        "projectLink": "string",
        "projectName": "string"
      },
      "relatedUsersDelete": {
        "reportId": "string",
        "statusId": "string",
        "usersToDeleteCount": "string"
      },
      "sharedUsers": [
        {
          "fullName": "string",
          "gravatarHash": "string",
          "inactive": true,
          "uid": "string",
          "username": "string"
        }
      ],
      "statusId": "string",
      "title": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userNotificationId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses

Status Meaning Description Schema
200 OK A paginated list of notifications. UserNotificationListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/userNotifications/

Mark all associated notifications with the user as read.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/userNotifications/ \
  -H 'Authorization: Bearer {access-token}'

Responses

Status Meaning Description Schema
204 No Content All notification were marked as read. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/userNotifications/{userNotificationId}/

Delete one notification associated with the user.

Code samples

# You can also use wget
curl -X DELETE http://10.97.111.38/api/v2/userNotifications/{userNotificationId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
userNotificationId path string true Unique identifier of the notification.

Responses

Status Meaning Description Schema
204 No Content Notification was deleted. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/userNotifications/{userNotificationId}/

Mark one associated notification with the user as read.

Code samples

# You can also use wget
curl -X PATCH http://10.97.111.38/api/v2/userNotifications/{userNotificationId}/ \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name In Type Required Description
userNotificationId path string true Unique identifier of the notification.

Responses

Status Meaning Description Schema
204 No Content Notification was marked as read. None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas

CreateRemoteEventResponse

{
  "message": "string"
}

Properties

Name Type Required Restrictions Description
message string true none The descriptive message about the event creation.

CustomerHeader

{
  "name": "string",
  "value": "string"
}

Properties

Name Type Required Restrictions Description
name string true none The name of the header.
value string true none The value of the header.

EventGroup

{
  "events": [
    {
      "id": "string",
      "label": "string"
    }
  ],
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
events [EventType] true none The events included in this group.
id string true none The id of the event group.
label string true none The display name of the event group.

EventGroupResponse

{
  "events": [
    "string"
  ],
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
events [string] true none Event types belonging to the group
id string true none Group ID
label string true none Group name for display

EventResponse

{
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
id string true none Event type as an ID
label string true none Event type for display

EventType

{
  "id": "string",
  "label": "string"
}

Properties

Name Type Required Restrictions Description
id string true none The id of the event type.
label string true none The display name of the event type.

NotificationChannel

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "uid": "string",
  "validateSsl": true
}

Properties

Name Type Required Restrictions Description
channelType string true none The type of the new notification channel.
contentType string¦null true none The content type of the messages of the new notification channel.
createdAt string(date-time) true none The date of the notification channel creation.
customHeaders [CustomerHeader]¦null true none Custom headers and their values to be sent in the new notification channel.
emailAddress string¦null true none The email address to be used in the new notification channel.
id string true none The id of the notification channel.
languageCode string¦null true none The preferred language code.
name string true none The name of the new notification channel.
orgId string¦null true none The id of organization that notification channel belongs to.
payloadUrl string(uri)¦null true none The payload URL of the new notification channel.
secretToken string¦null true none Secret token to be used for new notification channel.
uid string¦null true none The identifier of the user who created the channel.
validateSsl boolean¦null true none Defines if validate ssl or not in the notification channel.

Enumerated Values

Property Value
channelType Webhook
channelType Email
channelType Slack
channelType InApp
channelType Database
contentType application/x-www-form-urlencoded
contentType application/json
languageCode en
languageCode es_419
languageCode fr
languageCode ja
languageCode ko
languageCode ptBR

NotificationChannelCreate

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties

Name Type Required Restrictions Description
channelType string true none The type of the new notification channel.
contentType string false none The content type of the messages of the new notification channel.
customHeaders [CustomerHeader] false none Custom headers and their values to be sent in the new notification channel.
emailAddress string false none The email address to be used in the new notification channel.
languageCode string false none The preferred language code.
name string true none The name of the new notification channel.
orgId string false none The id of organization that notification channel belongs to.
payloadUrl string(uri) false none The payload URL of the new notification channel.
secretToken string false none Secret token to be used for new notification channel.
validateSsl boolean false none Defines if validate ssl or not in the notification channel.
verificationCode string false none Required if the channel type is Email.

Enumerated Values

Property Value
channelType Webhook
channelType Email
channelType Slack
channelType InApp
channelType Database
contentType application/x-www-form-urlencoded
contentType application/json
languageCode en
languageCode es_419
languageCode fr
languageCode ja
languageCode ko
languageCode ptBR

NotificationChannelResponse

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "createdAt": "2019-08-24T14:15:22Z",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "id": "string",
  "languageCode": "en",
  "lastNotificationAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "policyCount": 0,
  "secretToken": "string",
  "uid": "string",
  "validateSsl": true
}

Properties

Name Type Required Restrictions Description
channelType string true none The type of the new notification channel.
contentType string¦null true none The content type of the messages of the new notification channel.
createdAt string(date-time) true none The date of the notification channel creation.
customHeaders [CustomerHeader]¦null true none Custom headers and their values to be sent in the new notification channel.
emailAddress string¦null true none The email address to be used in the new notification channel.
id string true none The id of the notification channel.
languageCode string¦null true none The preferred language code.
lastNotificationAt string(date-time)¦null true none The timestamp of the last notification sent to the channel.
name string true none The name of the new notification channel.
orgId string¦null true none The id of organization that notification channel belongs to.
payloadUrl string(uri)¦null true none The payload URL of the new notification channel.
policyCount integer true none Count of policies assigned to the channel.
secretToken string¦null true none Secret token to be used for new notification channel.
uid string¦null true none The identifier of the user who created the channel.
validateSsl boolean¦null true none Defines if validate ssl or not in the notification channel.

Enumerated Values

Property Value
channelType Webhook
channelType Email
channelType Slack
channelType InApp
channelType Database
contentType application/x-www-form-urlencoded
contentType application/json
languageCode en
languageCode es_419
languageCode fr
languageCode ja
languageCode ko
languageCode ptBR

NotificationChannelUpdate

{
  "contentType": "application/x-www-form-urlencoded",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "languageCode": "en",
  "name": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true,
  "verificationCode": "string"
}

Properties

Name Type Required Restrictions Description
contentType string false none The content type of the messages of the new notification channel.
customHeaders [CustomerHeader] false none Custom headers and their values to be sent in the new notification channel.
emailAddress string false none The email address to be used in the new notification channel.
languageCode string false none The preferred language code.
name string false none The name of the new notification channel.
payloadUrl string(uri) false none The payload URL of the new notification channel.
secretToken string false none Secret token to be used for new notification channel.
validateSsl boolean false none Defines if validate ssl or not in the notification channel.
verificationCode string false none Required if the channel type is Email.

Enumerated Values

Property Value
contentType application/x-www-form-urlencoded
contentType application/json
languageCode en
languageCode es_419
languageCode fr
languageCode ja
languageCode ko
languageCode ptBR

NotificationChannelsListResponse

{
  "count": 0,
  "data": [
    {
      "channelType": "Webhook",
      "contentType": "application/x-www-form-urlencoded",
      "createdAt": "2019-08-24T14:15:22Z",
      "customHeaders": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "emailAddress": "string",
      "id": "string",
      "languageCode": "en",
      "lastNotificationAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "payloadUrl": "http://example.com",
      "policyCount": 0,
      "secretToken": "string",
      "uid": "string",
      "validateSsl": true
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none The number of channels returned.
data [NotificationChannelResponse] true none The notification channels.
next string¦null true none URL pointing to the next page.
previous string¦null true none URL pointing to the previous page.
totalCount integer true none The total number of channels that satisfy the query.

NotificationEmailChannelVerification

{
  "channelType": "string",
  "emailAddress": "string",
  "name": "string",
  "orgId": "string"
}

Properties

Name Type Required Restrictions Description
channelType string true none The type of the new notification channel
emailAddress string true none The email address of the recipient
name string true none The name of the new notification channel
orgId string false none The id of organization that notification channel belongs to

NotificationEmailChannelVerificationResponse

{
  "notificationId": "string"
}

Properties

Name Type Required Restrictions Description
notificationId string true none The response body is the json object with notification_id in it

NotificationEmailChannelVerificationStatus

{
  "emailAddress": "string",
  "verificationCode": "string"
}

Properties

Name Type Required Restrictions Description
emailAddress string true none The email address of the recipient
verificationCode string true none The user entered verification code

NotificationEmailChannelVerificationStatusResponse

{
  "status": true
}

Properties

Name Type Required Restrictions Description
status boolean true none The status shows if admin entered the correct 6 digit verification code

NotificationEventListResponse

{
  "eventGroups": [
    {
      "events": [
        "string"
      ],
      "id": "string",
      "label": "string"
    }
  ],
  "events": [
    {
      "id": "string",
      "label": "string"
    }
  ]
}

Properties

Name Type Required Restrictions Description
eventGroups [EventGroupResponse] true none Selectable event groups
events [EventResponse] true none Selectable individual events

NotificationLog

{
  "channelId": "string",
  "emailSubject": "string",
  "id": "string",
  "parentNotificationId": "string",
  "policyId": "string",
  "request": "string",
  "response": "string",
  "retryCount": 0,
  "status": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
channelId string true none The id of the channel that was used to send the notification.
emailSubject string¦null true none The email subject of the notification.
id string true none The id of the notification log.
parentNotificationId string¦null true none The id of the parent notification.
policyId string true none The id of the policy that was used to send the notification.
request string¦null true none The request that was sent in the notification.
response string¦null true none The response that was received after sending the notification.
retryCount integer¦null true none The number of attempts to send the notification.
status string true none The status of the notification.
timestamp string(date-time) true none The date when the notification was sent.

NotificationLogListDataResponse

{
  "channelId": "string",
  "emailSubject": "string",
  "id": "string",
  "parentNotificationId": "string",
  "policyId": "string",
  "request": {
    "body": "string",
    "headers": "string",
    "url": "http://example.com"
  },
  "response": {
    "body": "string",
    "duration": 0,
    "headers": "string",
    "statusCode": "string"
  },
  "retryCount": 0,
  "status": "string",
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
channelId string true none The id of the channel that was used to send the notification
emailSubject string true none The email subject
id string true none The id of the notification log
parentNotificationId string¦null true none The ID of the parent notification
policyId string true none the id of the policy that was used to send the notification
request RequestNotification true none The request that was sent in the notification
response ResponseNotification true none The response that was received after sending the notification
retryCount integer true none The count of the retries while sending the notification
status string¦null true none The status of the notification
timestamp string(date-time) true none The date and time when the notification was sent

NotificationLogListResponse

{
  "count": 0,
  "data": [
    {
      "channelId": "string",
      "emailSubject": "string",
      "id": "string",
      "parentNotificationId": "string",
      "policyId": "string",
      "request": {
        "body": "string",
        "headers": "string",
        "url": "http://example.com"
      },
      "response": {
        "body": "string",
        "duration": 0,
        "headers": "string",
        "statusCode": "string"
      },
      "retryCount": 0,
      "status": "string",
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none Number of items returned on this page
data [NotificationLogListDataResponse] true none An array notification logs
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page)
totalCount integer false none The total number of notifications

NotificationPoliciesListResponse

{
  "count": 0,
  "data": [
    {
      "active": true,
      "channel": {
        "channelType": "Webhook",
        "contentType": "application/x-www-form-urlencoded",
        "createdAt": "2019-08-24T14:15:22Z",
        "customHeaders": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "emailAddress": "string",
        "id": "string",
        "languageCode": "en",
        "name": "string",
        "orgId": "string",
        "payloadUrl": "http://example.com",
        "secretToken": "string",
        "uid": "string",
        "validateSsl": true
      },
      "channelId": "string",
      "created": "2019-08-24T14:15:22Z",
      "eventGroup": {
        "events": [
          {
            "id": "string",
            "label": "string"
          }
        ],
        "id": "string",
        "label": "string"
      },
      "eventType": {
        "id": "string",
        "label": "string"
      },
      "id": "string",
      "lastTriggered": "2019-08-24T14:15:22Z",
      "name": "string",
      "orgId": "string",
      "uid": "string"
    }
  ],
  "next": "string",
  "previous": "string",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none The number of policies returned.
data [NotificationPolicyResponse] true none The notification policies.
next string¦null true none URL pointing to the next page.
previous string¦null true none URL pointing to the previous page.
totalCount integer true none The total number of policies that satisfy the query.

NotificationPolicyCreate

{
  "active": true,
  "channelId": "string",
  "eventGroup": "dataset.all",
  "eventType": "dataset.created",
  "name": "string",
  "orgId": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Defines if the notification policy is active or not.
channelId string true none The id of the notification channel to be used to send the notification.
eventGroup string false none The group of the event that trigger the notification.
eventType string false none The type of the event that triggers the notification.
name string true none The name of the new notification policy.
orgId string false none The id of the organization that owns the notification policy.

Enumerated Values

Property Value
eventGroup dataset.all
eventGroup project.all
eventGroup model_deployments.critical_health
eventGroup model_deployments.health
eventGroup model_deployments.management_agent
eventGroup model_deployments.management_agent_health
eventGroup prediction_request.all
eventGroup challenger_management.all
eventGroup challenger_replay.all
eventGroup model_deployments.all
eventGroup comment.all
eventGroup perma_delete_project.all
eventGroup users_delete.all
eventGroup batch_predictions.all
eventGroup applications.all
eventGroup change_requests.all
eventGroup monitoring.all
eventType dataset.created
eventType dataset.registered
eventType dataset.deleted
eventType datasets.deleted
eventType datasetrelationship.created
eventType dataset.shared
eventType datasets.shared
eventType project.created
eventType project.deleted
eventType project.shared
eventType autopilot.complete
eventType autopilot.started
eventType autostart.failure
eventType model_deployments.None
eventType model_deployments.deployment_sharing
eventType model_deployments.model_replacement
eventType prediction_request.None
eventType prediction_request.failed
eventType model_deployments.model_replacement_lifecycle
eventType model_deployments.model_replacement_started
eventType model_deployments.model_replacement_succeeded
eventType model_deployments.model_replacement_failed
eventType model_deployments.model_replacement_validation_warning
eventType model_deployments.deployment_creation
eventType model_deployments.deployment_deletion
eventType model_deployments.health.base.base
eventType model_deployments.health.service_health.base
eventType model_deployments.service_health_yellow_from_green
eventType model_deployments.service_health_red
eventType model_deployments.health.data_drift.base
eventType model_deployments.data_drift_yellow_from_green
eventType model_deployments.data_drift_red
eventType model_deployments.accuracy_yellow_from_green
eventType model_deployments.accuracy_red
eventType model_deployments.health.fairness_health.base
eventType model_deployments.health.fairness_health.green_to_yellow
eventType model_deployments.health.fairness_health.red
eventType model_deployments.health.base.green
eventType model_deployments.service_health_green
eventType model_deployments.data_drift_green
eventType model_deployments.accuracy_green
eventType model_deployments.health.fairness_health.green
eventType model_deployments.retraining_policy_run_succeeded
eventType model_deployments.retraining_policy_run_failed
eventType model_deployments.challenger_scoring_finished
eventType model_deployments.challenger_scoring_success
eventType model_deployments.challenger_scoring_data_warning
eventType model_deployments.challenger_scoring_failure
eventType model_deployments.challenger_scoring_started
eventType model_deployments.challenger_model_validation_warning
eventType model_deployments.challenger_model_created
eventType model_deployments.challenger_model_deleted
eventType model_deployments.actuals_upload_failed
eventType model_deployments.actuals_upload_warning
eventType model_deployments.training_data_baseline_failed
eventType model_deployments.prediction_processing_rate_limit_reached
eventType model_deployments.deployment_monitoring_data_cleared
eventType model_deployments.deployment_launch_started
eventType model_deployments.deployment_launch_succeeded
eventType model_deployments.deployment_launch_failed
eventType model_deployments.deployment_shutdown_started
eventType model_deployments.deployment_shutdown_succeeded
eventType model_deployments.deployment_shutdown_failed
eventType model_deployments.management_agent_service_health_green
eventType model_deployments.management_agent_service_health_yellow
eventType model_deployments.management_agent_service_health_red
eventType model_deployments.management_agent_service_health_unknown
eventType comment.created
eventType comment.updated
eventType credits_system.empty_balance
eventType credits_system.credits_applied
eventType credits_system.credits_expired
eventType credits_system.credits_usage
eventType pipeline.failure
eventType downsampling_pipeline_run.started
eventType decision_flow.shared
eventType misc.asset_access_request
eventType misc.webhook_connection_test
eventType misc.webhook_resend
eventType misc.email_verification
eventType perma_delete_project.success
eventType perma_delete_project.failure
eventType users_delete.preview_started
eventType users_delete.preview_completed
eventType users_delete.preview_failed
eventType users_delete.started
eventType users_delete.completed
eventType users_delete.failed
eventType batch_predictions.success
eventType batch_predictions.failed
eventType batch_predictions.scheduler.auto_disabled
eventType application.created
eventType application.shared
eventType change_request.cancelled
eventType change_request.created
eventType change_request.deployment_approval_requested
eventType change_request.resolved
eventType change_request.proposed_changes_updated
eventType change_request.pending
eventType change_request.commenting_review_added
eventType change_request.approving_review_added
eventType change_request.changes_requesting_review_added
eventType monitoring.rate_limit_enforced
eventType monitoring.spooler_channel_base
eventType monitoring.spooler_channel_red
eventType monitoring.spooler_channel_green

NotificationPolicyMuteCreate

{
  "entityId": "string",
  "policyId": "string"
}

Properties

Name Type Required Restrictions Description
entityId string true none The id of the entity to mute the notification for
policyId string true none The id of the policy to mute notification for

NotificationPolicyMuteListResponse

{
  "count": 0,
  "data": [
    {
      "entityId": "string",
      "id": "string",
      "policyId": "string",
      "uid": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer true none The number of items returned on this page
data [NotificationPolicyMuteResponse] true none A list of Notification Policy Mutes
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page)
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page)
totalCount integer true none The total number of items returned by the query

NotificationPolicyMuteResponse

{
  "entityId": "string",
  "id": "string",
  "policyId": "string",
  "uid": "string"
}

Properties

Name Type Required Restrictions Description
entityId string true none The id of the entity to mute the notification for
id string true none The id of the notification policy mute
policyId string true none The id of the policy to mute notification for
uid string true none The uid of the notification policy mute

NotificationPolicyResponse

{
  "active": true,
  "channel": {
    "channelType": "Webhook",
    "contentType": "application/x-www-form-urlencoded",
    "createdAt": "2019-08-24T14:15:22Z",
    "customHeaders": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "emailAddress": "string",
    "id": "string",
    "languageCode": "en",
    "name": "string",
    "orgId": "string",
    "payloadUrl": "http://example.com",
    "secretToken": "string",
    "uid": "string",
    "validateSsl": true
  },
  "channelId": "string",
  "created": "2019-08-24T14:15:22Z",
  "eventGroup": {
    "events": [
      {
        "id": "string",
        "label": "string"
      }
    ],
    "id": "string",
    "label": "string"
  },
  "eventType": {
    "id": "string",
    "label": "string"
  },
  "id": "string",
  "lastTriggered": "2019-08-24T14:15:22Z",
  "name": "string",
  "orgId": "string",
  "uid": "string"
}

Properties

Name Type Required Restrictions Description
active boolean true none Defines if the notification policy is active or not.
channel NotificationChannel true none The information notification channel to be used to send the notification.
channelId string true none The id of the notification channel to be used to send the notification.
created string(date-time)¦null true none The date when the policy was created.
eventGroup EventGroup true none The group of the event that trigger the notification.
eventType EventType true none The type of the event that triggers the notification.
id string true none The id of the policy.
lastTriggered string(date-time)¦null true none The date when the last notification with the policy was triggered.
name string true none The name of the notification policy.
orgId string¦null true none The id of the organization that owns the notification policy.
uid string true none The identifier of the user who created the policy.

NotificationPolicyUpdate

{
  "active": true,
  "channelId": "string",
  "eventGroup": "dataset.all",
  "eventType": "dataset.created",
  "name": "string"
}

Properties

Name Type Required Restrictions Description
active boolean false none Defines if the notification policy is active or not.
channelId string false none The id of the notification channel to be used to send the notification.
eventGroup string false none The group of the event that trigger the notification.
eventType string false none The type of the event that triggers the notification.
name string false none The name of the notification policy.

Enumerated Values

Property Value
eventGroup dataset.all
eventGroup project.all
eventGroup model_deployments.critical_health
eventGroup model_deployments.health
eventGroup model_deployments.management_agent
eventGroup model_deployments.management_agent_health
eventGroup prediction_request.all
eventGroup challenger_management.all
eventGroup challenger_replay.all
eventGroup model_deployments.all
eventGroup comment.all
eventGroup perma_delete_project.all
eventGroup users_delete.all
eventGroup batch_predictions.all
eventGroup applications.all
eventGroup change_requests.all
eventGroup monitoring.all
eventType dataset.created
eventType dataset.registered
eventType dataset.deleted
eventType datasets.deleted
eventType datasetrelationship.created
eventType dataset.shared
eventType datasets.shared
eventType project.created
eventType project.deleted
eventType project.shared
eventType autopilot.complete
eventType autopilot.started
eventType autostart.failure
eventType model_deployments.None
eventType model_deployments.deployment_sharing
eventType model_deployments.model_replacement
eventType prediction_request.None
eventType prediction_request.failed
eventType model_deployments.model_replacement_lifecycle
eventType model_deployments.model_replacement_started
eventType model_deployments.model_replacement_succeeded
eventType model_deployments.model_replacement_failed
eventType model_deployments.model_replacement_validation_warning
eventType model_deployments.deployment_creation
eventType model_deployments.deployment_deletion
eventType model_deployments.health.base.base
eventType model_deployments.health.service_health.base
eventType model_deployments.service_health_yellow_from_green
eventType model_deployments.service_health_red
eventType model_deployments.health.data_drift.base
eventType model_deployments.data_drift_yellow_from_green
eventType model_deployments.data_drift_red
eventType model_deployments.accuracy_yellow_from_green
eventType model_deployments.accuracy_red
eventType model_deployments.health.fairness_health.base
eventType model_deployments.health.fairness_health.green_to_yellow
eventType model_deployments.health.fairness_health.red
eventType model_deployments.health.base.green
eventType model_deployments.service_health_green
eventType model_deployments.data_drift_green
eventType model_deployments.accuracy_green
eventType model_deployments.health.fairness_health.green
eventType model_deployments.retraining_policy_run_succeeded
eventType model_deployments.retraining_policy_run_failed
eventType model_deployments.challenger_scoring_finished
eventType model_deployments.challenger_scoring_success
eventType model_deployments.challenger_scoring_data_warning
eventType model_deployments.challenger_scoring_failure
eventType model_deployments.challenger_scoring_started
eventType model_deployments.challenger_model_validation_warning
eventType model_deployments.challenger_model_created
eventType model_deployments.challenger_model_deleted
eventType model_deployments.actuals_upload_failed
eventType model_deployments.actuals_upload_warning
eventType model_deployments.training_data_baseline_failed
eventType model_deployments.prediction_processing_rate_limit_reached
eventType model_deployments.deployment_monitoring_data_cleared
eventType model_deployments.deployment_launch_started
eventType model_deployments.deployment_launch_succeeded
eventType model_deployments.deployment_launch_failed
eventType model_deployments.deployment_shutdown_started
eventType model_deployments.deployment_shutdown_succeeded
eventType model_deployments.deployment_shutdown_failed
eventType model_deployments.management_agent_service_health_green
eventType model_deployments.management_agent_service_health_yellow
eventType model_deployments.management_agent_service_health_red
eventType model_deployments.management_agent_service_health_unknown
eventType comment.created
eventType comment.updated
eventType credits_system.empty_balance
eventType credits_system.credits_applied
eventType credits_system.credits_expired
eventType credits_system.credits_usage
eventType pipeline.failure
eventType downsampling_pipeline_run.started
eventType decision_flow.shared
eventType misc.asset_access_request
eventType misc.webhook_connection_test
eventType misc.webhook_resend
eventType misc.email_verification
eventType perma_delete_project.success
eventType perma_delete_project.failure
eventType users_delete.preview_started
eventType users_delete.preview_completed
eventType users_delete.preview_failed
eventType users_delete.started
eventType users_delete.completed
eventType users_delete.failed
eventType batch_predictions.success
eventType batch_predictions.failed
eventType batch_predictions.scheduler.auto_disabled
eventType application.created
eventType application.shared
eventType change_request.cancelled
eventType change_request.created
eventType change_request.deployment_approval_requested
eventType change_request.resolved
eventType change_request.proposed_changes_updated
eventType change_request.pending
eventType change_request.commenting_review_added
eventType change_request.approving_review_added
eventType change_request.changes_requesting_review_added
eventType monitoring.rate_limit_enforced
eventType monitoring.spooler_channel_base
eventType monitoring.spooler_channel_red
eventType monitoring.spooler_channel_green

NotificationResend

{
  "notificationId": "string"
}

Properties

Name Type Required Restrictions Description
notificationId string true none The id of notification to resend.

NotificationWebhookChannelStatusResponse

{
  "notificationLog": {
    "channelId": "string",
    "emailSubject": "string",
    "id": "string",
    "parentNotificationId": "string",
    "policyId": "string",
    "request": "string",
    "response": "string",
    "retryCount": 0,
    "status": "string",
    "timestamp": "2019-08-24T14:15:22Z"
  },
  "status": "string"
}

Properties

Name Type Required Restrictions Description
notificationLog NotificationLog true none The notification log record.
status string true none The status of the test notification.

NotificationWebhookChannelTestCreate

{
  "channelType": "Webhook",
  "contentType": "application/x-www-form-urlencoded",
  "customHeaders": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "emailAddress": "string",
  "name": "string",
  "orgId": "string",
  "payloadUrl": "http://example.com",
  "secretToken": "string",
  "validateSsl": true
}

Properties

Name Type Required Restrictions Description
channelType string true none The type of the new notification channel.
contentType string false none The content type of the messages of the new notification channel.
customHeaders [CustomerHeader] false none Custom headers and their values to be sent in the new notification channel.
emailAddress string false none The email address to be used in the new notification channel.
name string true none The name of the new notification channel.
orgId string false none The identifier of the organization that notification channel belongs to.
payloadUrl string(uri) false none The payload URL of the new notification channel.
secretToken string false none Secret token to be used for new notification channel.
validateSsl boolean false none Whether SSL will be validated in the notification channel.

Enumerated Values

Property Value
channelType Webhook
channelType Email
channelType Slack
channelType InApp
channelType Database
contentType application/x-www-form-urlencoded
contentType application/json

NotificationWebhookChannelTestId

{
  "notificationId": "string"
}

Properties

Name Type Required Restrictions Description
notificationId string true none The identifier of the notification.

PredictionRemoteEventData

{
  "error_code": "string",
  "model_id": "string",
  "response_body": "string",
  "status_code": 0,
  "user_id": "string"
}

Properties

Name Type Required Restrictions Description
error_code string¦null false none The error code if any.
model_id string¦null false none The identifier of the model.
response_body string true none The response body message of the prediction event.
status_code integer true none The response status code of the prediction event.
user_id string¦null false none The identifier of the user that accesses the deployment.

RemoteEventCreate

{
  "data": {
    "newModelId": "string",
    "oldModelId": "string",
    "reason": "string"
  },
  "deploymentId": "string",
  "eventType": "spoolerChannelGreen",
  "message": "string",
  "orgId": "string",
  "predictionEnvironmentId": "string",
  "predictionRequestData": {
    "error_code": "string",
    "model_id": "string",
    "response_body": "string",
    "status_code": 0,
    "user_id": "string"
  },
  "spoolerChannelData": {
    "name": "string",
    "type": "asyncMemory"
  },
  "timestamp": "2019-08-24T14:15:22Z"
}

Properties

Name Type Required Restrictions Description
data RemoteEventData false none Event payload.
deploymentId string false none The identifier of the deployment associated with the event.
eventType string true none The type of the event. Labels in all_lower_case are deprecated.
message string false none Descriptive message for health events.
orgId string¦null false none The identifier of the organization associated with the event.
predictionEnvironmentId string false none The identifier of the prediction environment associated with the event.
predictionRequestData PredictionRemoteEventData false none Prediction event payload.
spoolerChannelData SpoolerChannelEventData false none Spooler channel event payload.
timestamp string(date-time) true none The time when the event occurred.

Enumerated Values

Property Value
eventType spoolerChannelGreen
eventType model_deployments.service_health_red
eventType model_deployments.accuracy_green
eventType monitoring.spooler_channel_green
eventType model_deployments.data_drift_green
eventType model_deployments.accuracy_yellow_from_green
eventType serviceHealthChangeYellowFromGreen
eventType model_deployments.model_replacement
eventType model_deployments.accuracy_red
eventType monitoring.spooler_channel_red
eventType serviceHealthChangeRed
eventType serviceHealthChangeGreen
eventType predictionRequestFailed
eventType model_deployments.service_health_green
eventType model_deployments.data_drift_yellow_from_green
eventType spoolerChannelRed
eventType prediction_request.failed
eventType model_deployments.data_drift_red
eventType model_deployments.service_health_yellow_from_green

RemoteEventData

{
  "newModelId": "string",
  "oldModelId": "string",
  "reason": "string"
}

Properties

Name Type Required Restrictions Description
newModelId string false none The identifier of the model after replacement.
oldModelId string false none The identifier of the model before replacement.
reason string false none The explanation on why the model has been replaced.

RequestNotification

{
  "body": "string",
  "headers": "string",
  "url": "http://example.com"
}

Properties

Name Type Required Restrictions Description
body string true none The body of the request
headers string true none The headers of the request
url string(uri)¦null true none The URL of the request

ResponseNotification

{
  "body": "string",
  "duration": 0,
  "headers": "string",
  "statusCode": "string"
}

Properties

Name Type Required Restrictions Description
body string true none The body of the response
duration integer true none The duration
headers string true none The headers of the response
statusCode string true none The status code of the response

SpoolerChannelEventData

{
  "name": "string",
  "type": "asyncMemory"
}

Properties

Name Type Required Restrictions Description
name string true none Name or label of the spooler channel.
type string true none Type of the spooler channel.

Enumerated Values

Property Value
type asyncMemory
type filesystem
type kafka
type memory
type pubSub
type rabbitMQ
type sqs

UserNotificationListResponse

{
  "count": 0,
  "data": [
    {
      "callerUser": {
        "fullName": "string",
        "gravatarHash": "string",
        "inactive": true,
        "uid": "string",
        "username": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "description": "string",
      "eventType": "autopilot.complete",
      "isRead": true,
      "link": "string",
      "pushNotificationSent": true,
      "relatedComment": {
        "commentId": "string",
        "commentLink": "string",
        "entityId": "string",
        "entityType": "useCase",
        "inactive": true
      },
      "relatedDeployment": {
        "deploymentId": "string",
        "deploymentName": "string",
        "deploymentUrl": "string",
        "inactive": true,
        "modelId": "string",
        "projectId": "string",
        "userId": "string"
      },
      "relatedProject": {
        "inactive": true,
        "pid": "string",
        "projectLink": "string",
        "projectName": "string"
      },
      "relatedUsersDelete": {
        "reportId": "string",
        "statusId": "string",
        "usersToDeleteCount": "string"
      },
      "sharedUsers": [
        {
          "fullName": "string",
          "gravatarHash": "string",
          "inactive": true,
          "uid": "string",
          "username": "string"
        }
      ],
      "statusId": "string",
      "title": "string",
      "updated": "2019-08-24T14:15:22Z",
      "userNotificationId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties

Name Type Required Restrictions Description
count integer false none Number of items returned on this page.
data [UserNotificationResponse] true none An array of user's notifications.
next string(uri)¦null true none URL pointing to the next page (if null, there is no next page).
previous string(uri)¦null true none URL pointing to the previous page (if null, there is no previous page).
totalCount integer true none The total number of items across all pages.

UserNotificationRelatedCommentResponse

{
  "commentId": "string",
  "commentLink": "string",
  "entityId": "string",
  "entityType": "useCase",
  "inactive": true
}

Properties

Name Type Required Restrictions Description
commentId string true none The ID of the comment
commentLink string false none The link to the comment.
entityId string true none The ID of the commented entity
entityType string false none The type of the commented entity.
inactive boolean false none True if the comment was deleted.

Enumerated Values

Property Value
entityType useCase
entityType model
entityType catalog

UserNotificationRelatedDeploymentResponse

{
  "deploymentId": "string",
  "deploymentName": "string",
  "deploymentUrl": "string",
  "inactive": true,
  "modelId": "string",
  "projectId": "string",
  "userId": "string"
}

Properties

Name Type Required Restrictions Description
deploymentId string true none The ID of the deployment
deploymentName string¦null false none Deployment's label
deploymentUrl string false none The link to the deployment
inactive boolean false none True if the deployment was deleted.
modelId string¦null false none The ID of the related model
projectId string¦null false none The ID of the related project
userId string¦null false none The ID of the related user

UserNotificationRelatedProjectResponse

{
  "inactive": true,
  "pid": "string",
  "projectLink": "string",
  "projectName": "string"
}

Properties

Name Type Required Restrictions Description
inactive boolean false none True if the project was deleted.
pid string true none The ID of the project
projectLink string false none The link to the project.
projectName string¦null false none Project name.

UserNotificationRelatedUserResponse

{
  "fullName": "string",
  "gravatarHash": "string",
  "inactive": true,
  "uid": "string",
  "username": "string"
}

Properties

Name Type Required Restrictions Description
fullName string¦null false none User's full name.
gravatarHash string false none User's gravatar hash.
inactive boolean false none True if the user was deleted.
uid string true none The ID of the user
username string false none Username of the user.

UserNotificationRelatedUsersDeleteResponse

{
  "reportId": "string",
  "statusId": "string",
  "usersToDeleteCount": "string"
}

Properties

Name Type Required Restrictions Description
reportId string true none The ID of the users permanent delete report
statusId string true none The ID of the users delete status.
usersToDeleteCount string true none Number of users that will be deleted.

UserNotificationResponse

{
  "callerUser": {
    "fullName": "string",
    "gravatarHash": "string",
    "inactive": true,
    "uid": "string",
    "username": "string"
  },
  "created": "2019-08-24T14:15:22Z",
  "description": "string",
  "eventType": "autopilot.complete",
  "isRead": true,
  "link": "string",
  "pushNotificationSent": true,
  "relatedComment": {
    "commentId": "string",
    "commentLink": "string",
    "entityId": "string",
    "entityType": "useCase",
    "inactive": true
  },
  "relatedDeployment": {
    "deploymentId": "string",
    "deploymentName": "string",
    "deploymentUrl": "string",
    "inactive": true,
    "modelId": "string",
    "projectId": "string",
    "userId": "string"
  },
  "relatedProject": {
    "inactive": true,
    "pid": "string",
    "projectLink": "string",
    "projectName": "string"
  },
  "relatedUsersDelete": {
    "reportId": "string",
    "statusId": "string",
    "usersToDeleteCount": "string"
  },
  "sharedUsers": [
    {
      "fullName": "string",
      "gravatarHash": "string",
      "inactive": true,
      "uid": "string",
      "username": "string"
    }
  ],
  "statusId": "string",
  "title": "string",
  "updated": "2019-08-24T14:15:22Z",
  "userNotificationId": "string"
}

Properties

Name Type Required Restrictions Description
callerUser UserNotificationRelatedUserResponse true none Details about the user who triggered the notification.
created string(date-time) true none The ISO 8601 formatted date and time when the notification was created.
description string¦null true none Notification's description
eventType string true none The type of the notification.
isRead boolean true none True if the notification is already read.
link string true none Call-to-action link for the notification
pushNotificationSent boolean true none True if the notification was also sent via push notifications.
relatedComment UserNotificationRelatedCommentResponse false none Details about the comment related to the notification.
relatedDeployment UserNotificationRelatedDeploymentResponse false none Details about the deployment related to the notification.
relatedProject UserNotificationRelatedProjectResponse false none Details about the project related to the notification.
relatedUsersDelete UserNotificationRelatedUsersDeleteResponse false none Details about the users permanent delete.
sharedUsers [UserNotificationRelatedUserResponse] false none List of the user details a resource was shared with.
statusId string false none Asynchronous job status ID
title string¦null true none Notification's title
updated string(date-time) true none The ISO 8601 formatted date and time when the notification was updated.
userNotificationId string true none The ID of the notification

Enumerated Values

Property Value
eventType autopilot.complete
eventType project.shared
eventType comment.created
eventType comment.updated
eventType model_deployments.service_health_red
eventType model_deployments.data_drift_red
eventType model_deployments.accuracy_red
eventType model_deployments.health.fairness_health.red
eventType model_deployments.challenger_scoring_finished
eventType credits_system.credits_applied
eventType credits_system.credits_expired
eventType credits_system.empty_balance
eventType credits_system.credits_usage
eventType misc.asset_access_request
eventType users_delete.preview_started
eventType users_delete.preview_completed
eventType users_delete.preview_failed
eventType perma_delete_project.failure
eventType perma_delete_project.success
eventType pipeline.failure
eventType downsampling_pipeline_run.started
eventType decision_flow.shared

Updated December 7, 2022
Back to top