Get notification details
Retrieve a list of all user-enabled notifications. Additionally, you can:
- Specify channel_id to fetch details of a specific notification.
- Specify module to obtain details of notifications subscribed to events within that module.
Request URL
Bigin APIs are available across eight different domains, and you must choose the one relevant to your data center (DC):
- US
- EU
- AU
- IN
- CN
- JP
- SA
- CA
Authorization
For this endpoint, pass the access token as an authorization header. Read OAuth Authentication for more information about access tokens.
Authorization: Zoho-oauthtoken <ACCESS_TOKEN>
You must authenticate using an access token that's associated with the following scope:
- ZohoBigin.notifications.ALL
- ZohoBigin.notifications.READ
Request parameters
The available request parameters are provided below:
Query parameters
channel_id stringOptional
This is the unique identifier of a channel that is set while enabling a notification.
module stringOptional
This is the API name of the module for which the notification has been enabled. The possible modules for this endpoint and their API name are as follows:
Module | API Name |
|---|---|
Contacts | Contacts |
Pipelines | Pipelines |
Companies | Accounts |
Products | Products |
Tasks | Tasks |
Events | Events |
Calls | Calls |
page integerOptional
Represents the page index. This parameter lists the records from the given page index. The default value is 1.
per_page integerOptional
Represents the number of records per page index. The default value is 200, which means up to 200 records can be retrieved per page index.
Note:
The page and per_page parameters are utilized when you want to fetch more than 200 records. Since the maximum number of records per API call is 200, fetching records beyond the 200th position is not possible in a single call. However, by making two API calls with page values of 1 and 2 and a per_page value of 200, all 400 records can be retrieved.
Sample request 1
Copiedcurl "https://www.zohoapis.com/bigin/v2/actions/watch" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample response
Copied{
"watch": [
{
"notify_on_related_action": false,
"channel_expiry": "2023-10-10T20:10:09+05:30",
"return_affected_field_values": false,
"resource_uri": "https://www.zohoapis.com/bigin/v2/Contacts",
"resource_id": "5436046000000002179",
"notify_url": "https://webhook.site/924ad5dc-e982-4525-894a-a1851507b1ae",
"resource_name": "Contacts",
"fields": null,
"channel_id": "1001",
"events": [
"Contacts.create"
],
"token": "TOKEN_FOR_VERIFICATION_OF_1001"
},
{
"notify_on_related_action": false,
"channel_expiry": "2023-10-10T20:10:09+05:30",
"return_affected_field_values": false,
"resource_uri": "https://www.zohoapis.com/bigin/v2/Pipelines",
"resource_id": "5436046000000002181",
"notify_url": "https://webhook.site/924ad5dc-e982-4525-894a-a1851507b1ae",
"resource_name": "Pipelines",
"fields": null,
"channel_id": "1002",
"events": [
"Pipelines.create"
],
"token": "TOKEN_FOR_VERIFICATION_OF_1002"
}
],
"info": {
"per_page": 200,
"count": 2,
"page": 1,
"more_records": false
}
}Sample request 2
Copiedcurl "https://www.zohoapis.com/bigin/v2/actions/watch?channel_id=1001" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"Sample response
Copied{
"watch": [
{
"notify_on_related_action": false,
"channel_expiry": "2023-10-10T20:10:09+05:30",
"return_affected_field_values": false,
"resource_uri": "https://www.zohoapis.com/bigin/v2/Pipelines",
"resource_id": "5436046000000002181",
"notify_url": "https://webhook.site/924ad5dc-e982-4525-894a-a1851507b1ae",
"resource_name": "Pipelines",
"fields": null,
"channel_id": "1002",
"events": [
"Pipelines.create"
],
"token": "TOKEN_FOR_VERIFICATION_OF_1002"
}
],
"info": {
"per_page": 200,
"count": 1,
"page": 1,
"more_records": false
}
}