Notification Rules

Soda Cloud API Notification Rule Endpoints

List notification rules

get

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/notificationRules

This endpoint allows you to list the notification rules in your organization.

This GET is a paginated API that uses the following parameters to request specific details:

• size: Supply an integer value between 10 and 1000, inclusive. The default value is 10.
• page: Supply an integer value. The default value is 0.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Tags

Notification Rules

Rate limiting

60 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Query parameters

pageinteger · int32Optional

sizeinteger · int32Optional

Responses

200

Successful response

application/json

firstbooleanRequired

lastbooleanRequired

numberinteger · int32Required

sizeinteger · int32Required

totalElementsinteger · int32Required

totalPagesinteger · int32Required

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

500

Internal server error

application/json

get/api/v1/notificationRules

HTTPcURLJavaScriptPython

GET /api/v1/notificationRules HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "content": [
    {
      "createdAt": "2026-07-17T10:08:40.699Z",
      "customization": {
        "message": "text",
        "type": "rich"
      },
      "filter": {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": [
          {
            "expression": {
              "expression": {
                "expression": "[Circular Reference]",
                "expressions": "[Circular Reference]",
                "field": {
                  "attributeName": "text",
                  "field": "datasourceId"
                },
                "type": "equals",
                "value": "text",
                "values": [
                  "text"
                ]
              },
              "expressions": [
                "[Circular Reference]"
              ],
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      },
      "id": "text",
      "isDefault": true,
      "lastTriggeredAt": "2026-07-17T10:08:40.699Z",
      "name": "text",
      "ownerId": "text",
      "recipients": [
        {
          "customRoleId": "text",
          "email": "text",
          "integrationChannel": "text",
          "integrationId": "text",
          "role": "datasetOwner",
          "triggers": [
            {
              "level": "info",
              "scanState": "failed",
              "type": "testResultLevel"
            }
          ],
          "type": "email",
          "userGroupId": "text",
          "userId": "text"
        }
      ],
      "ruleType": "check",
      "status": "active",
      "updatedAt": "2026-07-17T10:08:40.699Z"
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1
}

Create a notification rule

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/notificationRules

Creates a notification rule with the provided filter and recipients.

The filter is a simplified expression tree (and/or/not/equals/contains/in) over check and monitor attributes; recipients can be users, user groups, emails, integrations, or roles.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Users must have global role permission MANAGE_NOTIFICATION_RULES to execute this call.

Tags

Notification Rules

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Body

application/json

namestringRequired

ruleTypeobject · enumRequiredPossible values:

statusobject · enumOptionalPossible values:

Responses

200

Successful response

application/json

createdAtstring · date-timeOptional

idstringOptional

isDefaultbooleanOptional

lastTriggeredAtstring · date-timeOptional

namestringOptional

ownerIdstringOptional

ruleTypeobject · enumOptionalPossible values:

statusobject · enumOptionalPossible values:

updatedAtstring · date-timeOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post/api/v1/notificationRules

HTTPcURLJavaScriptPython

POST /api/v1/notificationRules HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 2600

{
  "customization": {
    "message": "text",
    "type": "rich"
  },
  "filter": {
    "expression": {
      "expression": {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": [
          {
            "expression": {
              "expression": {
                "expression": "[Circular Reference]",
                "expressions": "[Circular Reference]",
                "field": {
                  "attributeName": "text",
                  "field": "datasourceId"
                },
                "type": "equals",
                "value": "text",
                "values": [
                  "text"
                ]
              },
              "expressions": [
                "[Circular Reference]"
              ],
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      },
      "expressions": [
        {
          "expression": {
            "expression": {
              "expression": "[Circular Reference]",
              "expressions": "[Circular Reference]",
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": [
              "[Circular Reference]"
            ],
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": "[Circular Reference]",
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        }
      ],
      "field": {
        "attributeName": "text",
        "field": "datasourceId"
      },
      "type": "equals",
      "value": "text",
      "values": [
        "text"
      ]
    },
    "expressions": [
      {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": "[Circular Reference]",
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "field": {
      "attributeName": "text",
      "field": "datasourceId"
    },
    "type": "equals",
    "value": "text",
    "values": [
      "text"
    ]
  },
  "name": "text",
  "recipients": [
    {
      "customRoleId": "text",
      "email": "text",
      "integrationChannel": "text",
      "integrationId": "text",
      "role": "datasetOwner",
      "triggers": [
        {
          "level": "info",
          "scanState": "failed",
          "type": "testResultLevel"
        }
      ],
      "type": "email",
      "userGroupId": "text",
      "userId": "text"
    }
  ],
  "ruleType": "check",
  "status": "active"
}

{
  "createdAt": "2026-07-17T10:08:40.699Z",
  "customization": {
    "message": "text",
    "type": "rich"
  },
  "filter": {
    "expression": {
      "expression": {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": [
          {
            "expression": {
              "expression": {
                "expression": "[Circular Reference]",
                "expressions": "[Circular Reference]",
                "field": {
                  "attributeName": "text",
                  "field": "datasourceId"
                },
                "type": "equals",
                "value": "text",
                "values": [
                  "text"
                ]
              },
              "expressions": [
                "[Circular Reference]"
              ],
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      },
      "expressions": [
        {
          "expression": {
            "expression": {
              "expression": "[Circular Reference]",
              "expressions": "[Circular Reference]",
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": [
              "[Circular Reference]"
            ],
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": "[Circular Reference]",
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        }
      ],
      "field": {
        "attributeName": "text",
        "field": "datasourceId"
      },
      "type": "equals",
      "value": "text",
      "values": [
        "text"
      ]
    },
    "expressions": [
      {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": "[Circular Reference]",
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "field": {
      "attributeName": "text",
      "field": "datasourceId"
    },
    "type": "equals",
    "value": "text",
    "values": [
      "text"
    ]
  },
  "id": "text",
  "isDefault": true,
  "lastTriggeredAt": "2026-07-17T10:08:40.699Z",
  "name": "text",
  "ownerId": "text",
  "recipients": [
    {
      "customRoleId": "text",
      "email": "text",
      "integrationChannel": "text",
      "integrationId": "text",
      "role": "datasetOwner",
      "triggers": [
        {
          "level": "info",
          "scanState": "failed",
          "type": "testResultLevel"
        }
      ],
      "type": "email",
      "userGroupId": "text",
      "userId": "text"
    }
  ],
  "ruleType": "check",
  "status": "active",
  "updatedAt": "2026-07-17T10:08:40.699Z"
}

Update a notification rule

post

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/notificationRules/{notificationRuleId}

Updates a notification rule. This is a full replacement: the rule's name, type, filter, recipients, status, and customization are all set from the request body.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Users must have global role permission MANAGE_NOTIFICATION_RULES to execute this call.

Tags

Notification Rules

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Path parameters

notificationRuleIdstringRequired

Body

application/json

namestringRequired

ruleTypeobject · enumRequiredPossible values:

statusobject · enumOptionalPossible values:

Responses

200

Successful response

application/json

createdAtstring · date-timeOptional

idstringOptional

isDefaultbooleanOptional

lastTriggeredAtstring · date-timeOptional

namestringOptional

ownerIdstringOptional

ruleTypeobject · enumOptionalPossible values:

statusobject · enumOptionalPossible values:

updatedAtstring · date-timeOptional

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post/api/v1/notificationRules/{notificationRuleId}

HTTPcURLJavaScriptPython

POST /api/v1/notificationRules/{notificationRuleId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 2600

{
  "customization": {
    "message": "text",
    "type": "rich"
  },
  "filter": {
    "expression": {
      "expression": {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": [
          {
            "expression": {
              "expression": {
                "expression": "[Circular Reference]",
                "expressions": "[Circular Reference]",
                "field": {
                  "attributeName": "text",
                  "field": "datasourceId"
                },
                "type": "equals",
                "value": "text",
                "values": [
                  "text"
                ]
              },
              "expressions": [
                "[Circular Reference]"
              ],
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      },
      "expressions": [
        {
          "expression": {
            "expression": {
              "expression": "[Circular Reference]",
              "expressions": "[Circular Reference]",
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": [
              "[Circular Reference]"
            ],
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": "[Circular Reference]",
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        }
      ],
      "field": {
        "attributeName": "text",
        "field": "datasourceId"
      },
      "type": "equals",
      "value": "text",
      "values": [
        "text"
      ]
    },
    "expressions": [
      {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": "[Circular Reference]",
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "field": {
      "attributeName": "text",
      "field": "datasourceId"
    },
    "type": "equals",
    "value": "text",
    "values": [
      "text"
    ]
  },
  "name": "text",
  "recipients": [
    {
      "customRoleId": "text",
      "email": "text",
      "integrationChannel": "text",
      "integrationId": "text",
      "role": "datasetOwner",
      "triggers": [
        {
          "level": "info",
          "scanState": "failed",
          "type": "testResultLevel"
        }
      ],
      "type": "email",
      "userGroupId": "text",
      "userId": "text"
    }
  ],
  "ruleType": "check",
  "status": "active"
}

{
  "createdAt": "2026-07-17T10:08:40.699Z",
  "customization": {
    "message": "text",
    "type": "rich"
  },
  "filter": {
    "expression": {
      "expression": {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": [
          {
            "expression": {
              "expression": {
                "expression": "[Circular Reference]",
                "expressions": "[Circular Reference]",
                "field": {
                  "attributeName": "text",
                  "field": "datasourceId"
                },
                "type": "equals",
                "value": "text",
                "values": [
                  "text"
                ]
              },
              "expressions": [
                "[Circular Reference]"
              ],
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          }
        ],
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      },
      "expressions": [
        {
          "expression": {
            "expression": {
              "expression": "[Circular Reference]",
              "expressions": "[Circular Reference]",
              "field": {
                "attributeName": "text",
                "field": "datasourceId"
              },
              "type": "equals",
              "value": "text",
              "values": [
                "text"
              ]
            },
            "expressions": [
              "[Circular Reference]"
            ],
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": "[Circular Reference]",
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        }
      ],
      "field": {
        "attributeName": "text",
        "field": "datasourceId"
      },
      "type": "equals",
      "value": "text",
      "values": [
        "text"
      ]
    },
    "expressions": [
      {
        "expression": {
          "expression": {
            "expression": "[Circular Reference]",
            "expressions": "[Circular Reference]",
            "field": {
              "attributeName": "text",
              "field": "datasourceId"
            },
            "type": "equals",
            "value": "text",
            "values": [
              "text"
            ]
          },
          "expressions": [
            "[Circular Reference]"
          ],
          "field": {
            "attributeName": "text",
            "field": "datasourceId"
          },
          "type": "equals",
          "value": "text",
          "values": [
            "text"
          ]
        },
        "expressions": "[Circular Reference]",
        "field": {
          "attributeName": "text",
          "field": "datasourceId"
        },
        "type": "equals",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "field": {
      "attributeName": "text",
      "field": "datasourceId"
    },
    "type": "equals",
    "value": "text",
    "values": [
      "text"
    ]
  },
  "id": "text",
  "isDefault": true,
  "lastTriggeredAt": "2026-07-17T10:08:40.699Z",
  "name": "text",
  "ownerId": "text",
  "recipients": [
    {
      "customRoleId": "text",
      "email": "text",
      "integrationChannel": "text",
      "integrationId": "text",
      "role": "datasetOwner",
      "triggers": [
        {
          "level": "info",
          "scanState": "failed",
          "type": "testResultLevel"
        }
      ],
      "type": "email",
      "userGroupId": "text",
      "userId": "text"
    }
  ],
  "ruleType": "check",
  "status": "active",
  "updatedAt": "2026-07-17T10:08:40.699Z"
}

Delete a notification rule

delete

https://cloud.soda.iohttps://cloud.us.soda.io

/api/v1/notificationRules/{notificationRuleId}

Schedules a notification rule for deletion. Deletion is processed asynchronously.

Authentication

User authentication required: true

This endpoint accepts authentication via API keys in the Basic authentication header, or a pre-authenticated token in HTTP cookie token. Cookie sessions extend automatically on each request.

Authorization

Users must have global role permission MANAGE_NOTIFICATION_RULES to execute this call.

Tags

Notification Rules

Rate limiting

10 requests/60 seconds

Authorizations

basicAuthApiKeycookieToken

AuthorizationstringRequired

Path parameters

notificationRuleIdstringRequired

Responses

200

Successful response

application/json

messagestringRequired

400

Bad request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

429

Too many requests

application/json

500

Internal server error

application/json

delete/api/v1/notificationRules/{notificationRuleId}

HTTPcURLJavaScriptPython

DELETE /api/v1/notificationRules/{notificationRuleId} HTTP/1.1
Host: cloud.soda.io
Authorization: Basic username:password
Accept: */*

{
  "message": "text"
}