> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: Notifications Get Notifications
> List your active Zoho CRM notification channels and the events they watch. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.
List your active Zoho CRM notification channels and the events they watch.
> [!NOTE]
>
> Tool ID: `zoho_crm_notifications_get_notifications`
## Run this action
Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.
```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_notifications_get_notifications',
{
"module": "example",
"channel_id": "channel_123"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_notifications_get_notifications --input '{
"module": "example",
"channel_id": "channel_123"
}' --json
```
## Example response
The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"data": {
"watch": [
{
"notify_on_related_action": true,
"channel_expiry": "2026-01-15T12:00:00Z",
"return_affected_field_values": true
}
],
"info": {
"per_page": 123,
"count": 100,
"page": 100
}
}
}
```
Use `deepline describe zoho_crm_notifications_get_notifications --json` for the latest machine-readable contract.
## Input reference
Get a list of all active notification channels for the user.
| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | No | — | Module API name filter (e.g. Leads). Maximum length: 64. |
| `payload.channel_id` | `string` | No | — | Single channel id filter. Maximum length: 64. |
Show raw input schema
### Input JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Get a list of all active notification channels for the user.",
"properties": {
"module": {
"type": "string",
"description": "Module API name filter (e.g. Leads).",
"maxLength": 64
},
"channel_id": {
"type": "string",
"description": "Single channel id filter.",
"maxLength": 64
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A wrapper for the list of notification channels and pagination information. |
| `result.data.watch` | `array` | No | — | List of active notification channels. Maximum items: 200. |
| `result.data.watch[].notify_on_related_action` | `boolean` | No | — | Whether to notify on related associated record actions. |
| `result.data.watch[].channel_expiry` | `string` | No | — | Channel expiry timestamp. Format: `date-time`. |
| `result.data.watch[].return_affected_field_values` | `boolean` | No | — | Whether to return affected field values in notification payloads. |
| `result.data.watch[].resource_uri` | `string` | No | — | URI of the resource. Maximum length: 255. |
| `result.data.watch[].resource_id` | `string` | No | — | Identifier of the resource. Maximum length: 64. |
| `result.data.watch[].notify_url` | `string` | No | — | Callback URL for notifications. Maximum length: 255. |
| `result.data.watch[].resource_name` | `string` | No | — | Name of the resource. Maximum length: 128. |
| `result.data.watch[].fields` | `array \| null` | No | — | Fields to include in the notification. |
| `result.data.watch[].notification_condition` | `array \| null` | No | — | Conditions for notifications. |
| `result.data.watch[].notification_condition[].field_selection` | `object` | No | — | Field selection details. |
| `result.data.watch[].notification_condition[].field_selection.group_operator` | `string` | No | — | Operator for grouping conditions. Maximum length: 3. |
| `result.data.watch[].notification_condition[].field_selection.group` | `array` | No | — | Group of field conditions. Maximum items: 2. |
| `result.data.watch[].notification_condition[].field_selection.group[].field` | `object` | No | — | Field details. |
| `result.data.watch[].notification_condition[].field_selection.group[].field.api_name` | `string` | No | — | API name of the field. Maximum length: 128. |
| `result.data.watch[].notification_condition[].field_selection.group[].field.id` | `string` | No | — | Identifier of the field. Maximum length: 64. |
| `result.data.watch[].notification_condition[].field_selection.group[].group_operator` | `"and" \| "or" \| null` | No | — | Operator for grouping sub-conditions. Allowed: `and`, `or`, `null`. |
| `result.data.watch[].notification_condition[].field_selection.group[].group` | `array \| null` | No | — | Sub-group of field conditions. |
| `result.data.watch[].notification_condition[].module` | `object` | No | — | Module details. |
| `result.data.watch[].notification_condition[].module.api_name` | `string` | No | — | API name of the module. Maximum length: 255. |
| `result.data.watch[].notification_condition[].module.id` | `string` | No | — | Identifier of the module. Maximum length: 64. |
| `result.data.watch[].notification_condition[].type` | `string` | No | — | Type of notification condition. Maximum length: 32. |
| `result.data.watch[].channel_id` | `string` | No | — | Identifier of the notification channel. Maximum length: 64. |
| `result.data.watch[].events` | `array` | No | — | Events subscribed for notifications. Maximum items: 10. |
| `result.data.watch[].token` | `string \| null` | No | — | Verification token for the notification channel. Maximum length: 255. |
| `result.data.info` | `object` | No | — | Information about the pagination and record count. |
| `result.data.info.per_page` | `integer` | No | — | Number of records per page. Format: `int32`. Maximum: 200. |
| `result.data.info.count` | `integer` | No | — | Total number of records returned. Format: `int32`. Maximum: 100. |
| `result.data.info.page` | `integer` | No | — | Current page number. Format: `int32`. Maximum: 100. |
| `result.data.info.more_records` | `boolean` | No | — | Indicates if more records are available. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "A wrapper for the list of notification channels and pagination information.",
"properties": {
"watch": {
"type": "array",
"description": "List of active notification channels.",
"maxItems": 200,
"items": {
"type": "object",
"description": "Notification channel details.",
"properties": {
"notify_on_related_action": {
"type": "boolean",
"description": "Whether to notify on related associated record actions."
},
"channel_expiry": {
"type": "string",
"description": "Channel expiry timestamp.",
"format": "date-time"
},
"return_affected_field_values": {
"type": "boolean",
"description": "Whether to return affected field values in notification payloads."
},
"resource_uri": {
"type": "string",
"description": "URI of the resource.",
"maxLength": 255
},
"resource_id": {
"type": "string",
"description": "Identifier of the resource.",
"maxLength": 64
},
"notify_url": {
"type": "string",
"description": "Callback URL for notifications.",
"maxLength": 255
},
"resource_name": {
"type": "string",
"description": "Name of the resource.",
"maxLength": 128
},
"fields": {
"type": [
"array",
"null"
],
"description": "Fields to include in the notification.",
"items": {}
},
"notification_condition": {
"type": [
"array",
"null"
],
"description": "Conditions for notifications.",
"items": {
"type": "object",
"description": "Notification condition details.",
"properties": {
"field_selection": {
"type": "object",
"description": "Field selection details.",
"properties": {
"group_operator": {
"type": "string",
"description": "Operator for grouping conditions.",
"maxLength": 3
},
"group": {
"type": "array",
"description": "Group of field conditions.",
"maxItems": 2,
"items": {
"type": "object",
"description": "Field condition details.",
"properties": {
"field": {
"type": "object",
"description": "Field details.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the field.",
"maxLength": 128
},
"id": {
"type": "string",
"description": "Identifier of the field.",
"maxLength": 64
}
},
"additionalProperties": false
},
"group_operator": {
"type": [
"string",
"null"
],
"description": "Operator for grouping sub-conditions.",
"enum": [
"and",
"or",
null
]
},
"group": {
"type": [
"array",
"null"
],
"description": "Sub-group of field conditions.",
"items": {}
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"module": {
"type": "object",
"description": "Module details.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the module.",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Identifier of the module.",
"maxLength": 64
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"description": "Type of notification condition.",
"maxLength": 32
}
},
"additionalProperties": false
}
},
"channel_id": {
"type": "string",
"description": "Identifier of the notification channel.",
"maxLength": 64
},
"events": {
"type": "array",
"description": "Events subscribed for notifications.",
"maxItems": 10,
"items": {
"type": "string",
"description": "Event name.",
"maxLength": 128
}
},
"token": {
"type": [
"string",
"null"
],
"description": "Verification token for the notification channel.",
"maxLength": 255
}
},
"additionalProperties": false
}
},
"info": {
"type": "object",
"description": "Information about the pagination and record count.",
"properties": {
"per_page": {
"type": "integer",
"description": "Number of records per page.",
"maximum": 200,
"format": "int32"
},
"count": {
"type": "integer",
"description": "Total number of records returned.",
"maximum": 100,
"format": "int32"
},
"page": {
"type": "integer",
"description": "Current page number.",
"maximum": 100,
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more records are available."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.