enbbox 1.0.1

Notification infrastructure API — open-source alternative to Novu/Courier
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# \NotificationsApi

All URIs are relative to *https://api.enbbox.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_notification**](NotificationsApi.md#get_notification) | **GET** /v1/notifications/{id}/ | GET /v1/notifications/:id
[**get_notification_jobs**](NotificationsApi.md#get_notification_jobs) | **GET** /v1/notifications/{id}/jobs/ | GET /v1/notifications/:id/jobs
[**list_notifications**](NotificationsApi.md#list_notifications) | **GET** /v1/notifications/ | GET /v1/notifications



## get_notification

> models::NotificationLog get_notification(id)
GET /v1/notifications/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Notification ID | [required] |

### Return type

[**models::NotificationLog**](NotificationLog.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_notification_jobs

> Vec<models::JobLog> get_notification_jobs(id)
GET /v1/notifications/:id/jobs

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Notification ID | [required] |

### Return type

[**Vec<models::JobLog>**](JobLog.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_notifications

> models::PaginatedNotificationLog list_notifications(limit, offset, q, filter_by)
GET /v1/notifications

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**limit** | Option<**u32**> | Maximum number of items to return (1–100, default: 10). |  |
**offset** | Option<**u32**> | Number of items to skip before returning results (default: 0). |  |
**q** | Option<**String**> | Optional full-text search query. When present, listing is powered by Typesense full-text search. |  |
**filter_by** | Option<**String**> | Optional Typesense filter expression for narrowing results. Example: `identifier:=acme-corp` or `name:=General`. |  |

### Return type

[**models::PaginatedNotificationLog**](Paginated_NotificationLog.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)