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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

# \WorkflowsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_workflow**](WorkflowsApi.md#create_workflow) | **POST** /v1/workflows/ | POST /v1/workflows
[**delete_workflow**](WorkflowsApi.md#delete_workflow) | **DELETE** /v1/workflows/{id}/ | DELETE /v1/workflows/:id
[**duplicate_workflow**](WorkflowsApi.md#duplicate_workflow) | **POST** /v1/workflows/{id}/duplicate/ | POST /v1/workflows/:id/duplicate — clone workflow
[**get_step**](WorkflowsApi.md#get_step) | **GET** /v1/workflows/{id}/steps/{step_id}/ | GET /v1/workflows/:id/steps/:step_id — get step details
[**get_workflow**](WorkflowsApi.md#get_workflow) | **GET** /v1/workflows/{id}/ | GET /v1/workflows/:id
[**list_workflows**](WorkflowsApi.md#list_workflows) | **GET** /v1/workflows/ | GET /v1/workflows
[**step_preview**](WorkflowsApi.md#step_preview) | **POST** /v1/workflows/{id}/step/{step_id}/preview/ | POST /v1/workflows/:id/step/:step_id/preview — render step template
[**sync_workflow**](WorkflowsApi.md#sync_workflow) | **PUT** /v1/workflows/{id}/sync/ | PUT /v1/workflows/:id/sync — sync from code-first workflow definition
[**update_workflow**](WorkflowsApi.md#update_workflow) | **PUT** /v1/workflows/{id}/ | PUT /v1/workflows/:id
[**update_workflow_status**](WorkflowsApi.md#update_workflow_status) | **PUT** /v1/workflows/{id}/status/ | PUT /v1/workflows/:id/status



## create_workflow

> models::WorkflowRecord create_workflow(create_workflow)
POST /v1/workflows

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_workflow** | [**CreateWorkflow**](CreateWorkflow.md) |  | [required] |

### Return type

[**models::WorkflowRecord**](WorkflowRecord.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)


## delete_workflow

> delete_workflow(id)
DELETE /v1/workflows/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Workflow 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)


## duplicate_workflow

> models::WorkflowRecord duplicate_workflow(id)
POST /v1/workflows/:id/duplicate — clone workflow

### Parameters


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

### Return type

[**models::WorkflowRecord**](WorkflowRecord.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_step

> models::StepRecord get_step(id, step_id)
GET /v1/workflows/:id/steps/:step_id — get step details

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |
**step_id** | **String** |  | [required] |

### Return type

[**models::StepRecord**](StepRecord.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_workflow

> models::WorkflowRecord get_workflow(id)
GET /v1/workflows/:id

### Parameters


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

### Return type

[**models::WorkflowRecord**](WorkflowRecord.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_workflows

> models::PaginatedWorkflowRecord list_workflows(limit, offset, q, filter_by)
GET /v1/workflows

### 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::PaginatedWorkflowRecord**](Paginated_WorkflowRecord.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)


## step_preview

> models::PreviewResult step_preview(id, step_id, step_preview)
POST /v1/workflows/:id/step/:step_id/preview — render step template

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |
**step_id** | **String** |  | [required] |
**step_preview** | [**StepPreview**](StepPreview.md) |  | [required] |

### Return type

[**models::PreviewResult**](PreviewResult.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)


## sync_workflow

> models::WorkflowRecord sync_workflow(id, sync_workflow)
PUT /v1/workflows/:id/sync — sync from code-first workflow definition

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** |  | [required] |
**sync_workflow** | [**SyncWorkflow**](SyncWorkflow.md) |  | [required] |

### Return type

[**models::WorkflowRecord**](WorkflowRecord.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)


## update_workflow

> models::WorkflowRecord update_workflow(id, update_workflow)
PUT /v1/workflows/:id

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Workflow ID | [required] |
**update_workflow** | [**UpdateWorkflow**](UpdateWorkflow.md) |  | [required] |

### Return type

[**models::WorkflowRecord**](WorkflowRecord.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)


## update_workflow_status

> models::WorkflowRecord update_workflow_status(id, workflow_status)
PUT /v1/workflows/:id/status

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Workflow ID | [required] |
**workflow_status** | [**WorkflowStatus**](WorkflowStatus.md) |  | [required] |

### Return type

[**models::WorkflowRecord**](WorkflowRecord.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)