HumHub - Notification API (1.0.0)

Download OpenAPI specification:Download

Welcome to the HumHub notification module API reference.

Notification

API to access notification information.

Find all user notifications

query Parameters

page	string >= 0 The number of page of the result set.
limit	string [ 1 .. 50 ] Default: 20 The numbers of items to return per page.
excludeFilters	Array of strings Items Enum: "admin" "calendar" "task" "task_reminder" "comments" "content_created" "like" "space_member" "followed" "mentioned" Filters to exclude notifications from result.

Responses

Response samples

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 32,
"class": "humhub\\modules\\content\\notifications\\ContentCreated",
"output": "<strong>John Smith</strong> created post \"Calvin Klein – Between love and madness lies obsession.\"",
"originator": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"source": {"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
},
"createdAt": "2019-03-05 15:35:02"
}
]
}

Get notification by id

path Parameters

required

integer

The id of notification

Responses

Response samples

Content type

application/json

{"id": 32,
"class": "humhub\\modules\\content\\notifications\\ContentCreated",
"output": "<strong>John Smith</strong> created post \"Calvin Klein – Between love and madness lies obsession.\"",
"originator": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"source": {"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
},
"createdAt": "2019-03-05 15:35:02"
}

Find unseen user notifications

query Parameters

page	string >= 0 The number of page of the result set.
limit	string [ 1 .. 50 ] Default: 20 The numbers of items to return per page.

Responses

Response samples

Content type

application/json

{"total": 76,
"page": 1,
"pages": 8,
"links": {"self": "{endpoint_path}?page=1&per-page=10",
"next": "{endpoint_path}?page=2&per-page=10",
"last": "{endpoint_path}?page=8&per-page=10"
},
"results": [{"id": 32,
"class": "humhub\\modules\\content\\notifications\\ContentCreated",
"output": "<strong>John Smith</strong> created post \"Calvin Klein – Between love and madness lies obsession.\"",
"originator": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"source": {"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"content": {"metadata": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"object_model": "humhub\\modules\\post\\models\\Post",
"object_id": 12,
"visibility": 1,
"state": 1,
"archived": true,
"hidden": true,
"pinned": false,
"locked_comments": false,
"scheduled_at": "2023-09-14 05:15:00",
"created_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"created_at": "2022-04-13 05:15:43",
"updated_by": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"updated_at": "2022-05-21 06:20:18",
"url": "http://localhost/p/humhub/master/content/perma?id=109",
"contentcontainer_id": 5,
"stream_channel": "default"
},
"comments": {"total": 55,
"latestComments": [{"id": 14,
"message": "Calvin Klein – Between love and madness lies obsession.",
"objectModel": "humhub\\modules\\post\\models\\Post",
"objectId": 123,
"createdBy": {"id": 14,
"guid": "cd081891-d2e2-40d5-84a4-b47309e71c80",
"display_name": "John Doe",
"url": "http://localhost/p/humhub/master/u/j.doe/"
},
"createdAt": "2018-08-09 14:22:03",
"commentsCount": 5,
"comments": [{ }
]
}
]
},
"likes": {"total": 35
},
"files": {"id": 14,
"guid": "bded6dc7-e6f4-417e-a638-b653525529ca",
"mime_type": "text/plain",
"size": 14353,
"file_name": "image.jpg",
"url": "http://localhost/p/humhub/master/file/file/download?guid=bded6dc7-e6f4-417e-a638-b653525529ca"
},
"topics": [{"id": 135,
"name": "News"
}
]
}
},
"createdAt": "2019-03-05 15:35:02"
}
]
}

Mark all notifications as seen

Responses

Response samples

Content type

application/json

{"code": 200,
"message": "All notifications successfully marked as seen"
}