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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124

# \EventsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_event**](EventsApi.md#cancel_event) | **DELETE** /v1/events/{transaction_id}/ | DELETE /v1/events/:transaction_id
[**trigger_broadcast**](EventsApi.md#trigger_broadcast) | **POST** /v1/events/trigger/broadcast/ | POST /v1/events/trigger/broadcast — broadcast to all subscribers
[**trigger_bulk**](EventsApi.md#trigger_bulk) | **POST** /v1/events/trigger/bulk/ | POST /v1/events/trigger/bulk
[**trigger_event**](EventsApi.md#trigger_event) | **POST** /v1/events/trigger/ | POST /v1/events/trigger



## cancel_event

> cancel_event(transaction_id)
DELETE /v1/events/:transaction_id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**transaction_id** | **String** | Transaction ID | [required] |

### Return type

 (empty response body)

### Authorization

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

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[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)


## trigger_broadcast

> models::TriggerResult trigger_broadcast(broadcast_trigger)
POST /v1/events/trigger/broadcast — broadcast to all subscribers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**broadcast_trigger** | [**BroadcastTrigger**](BroadcastTrigger.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## trigger_bulk

> Vec<models::TriggerResult> trigger_bulk(bulk_trigger)
POST /v1/events/trigger/bulk

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**bulk_trigger** | [**BulkTrigger**](BulkTrigger.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## trigger_event

> models::TriggerResult trigger_event(trigger_event)
POST /v1/events/trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**trigger_event** | [**TriggerEvent**](TriggerEvent.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)