-
Notifications
You must be signed in to change notification settings - Fork 3
/
Webhooks Management API.postman_collection.json
648 lines (648 loc) · 38.3 KB
/
Webhooks Management API.postman_collection.json
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
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
{
"info": {
"_postman_id": "677aa461-ddc2-443e-b153-f6d60586267b",
"name": "Webhooks Management API",
"description": "Webhooks Management API allows you to manage your webhooks configuration. You can subscribe to one or several events, retrieve the webhooks, update them or even delete them if needed.\n\n",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Webhooks",
"item": [
{
"name": "Create Webhook",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"http://webhook.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"JSON\",\r\n \"headers\": {\r\n \"Account\": \"DeveloperPortal7000\"\r\n },\r\n \"events\": [\r\n \"ENROUTE_DR\",\r\n \"DELIVERED_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages"
]
},
"description": "Create a webhook for one or more of the specified events.\nA webhook would typically have the following structure:\n```\n{\n \"url\": \"http://webhook.com\",\n \"method\": \"POST\",\n \"encoding\": \"JSON\",\n \"headers\": {\n \"Account\": \"DeveloperPortal7000\"\n },\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\nA valid webhook must consist of the following properties:\n- ```url``` The configured URL which will trigger the webhook when a selected event occurs.\n- ```method``` The methods to map CRUD (create, retrieve, update, delete) operations to HTTP requests.\n- ```encoding``` Webhooks can be delivered using different content types. You can choose from ```JSON```, ```FORM_ENCODED``` or ```XML```. This will automatically add the Content-Type header for you so you don't have to add it again in the `headers` property.\n- ```headers``` HTTP header fields which provide required information about the request or response, or about the object sent in the message body. This should NOT include the `Content-Type` header.\n- ```events``` Event or events that will trigger the webhook. Atleast one event should be present.\n- ```template``` The structure of the payload that will be returned. You can format this in JSON or XML.\n#### Types of Events\nYou can select all of the events (listed below) or combine them in whatever way you like but atleast one event must be used. Otherwise, the webhook won't be created.\nA webhook will be triggered when any one or more of the events occur:\n+ **SMS**\n + `RECEIVED_SMS` Receive an SMS\n + `OPT_OUT_SMS` Opt-out occured\n+ **MMS**\n + `RECEIVED_MMS` Receive an MMS\n+ **DR (Delivery Reports)**\n + `ENROUTE_DR` Message is enroute\n + `EXPIRED_DR` Message has expired\n + `REJECTED_DR` Message is rejected\n + `FAILED_DR` Message has failed \n + `DELIVERED_DR` Message is delivered\n + `SUBMITTED_DR` Message is submitted\n#### Template Parameters\nYou can choose what to include in the data that will be sent as the payload via the Webhook. It's upto you to choose what format you would like the payload to be returned. You can choose between JSON or XML.\nKeep in my mind, if you've chosen JSON as the format, you must escape the JSON in the template value (see example above).\nThe table illustrates a list of all the parameters that can be included in the template and which event types it can be applied to.\n| Data | Parameter Name | Example | Event Type |\n|:--|--|--|--|--|\n| **Service Type** | $type| `SMS` | `DR` `MO` `MO MMS` |\n| **Message ID** | $mtId, $messageId| `877c19ef-fa2e-4cec-827a-e1df9b5509f7` | `DR` `MO` `MO MMS`|\n| **Delivery Report ID** |$drId, $reportId| `01e1fa0a-6e27-4945-9cdb-18644b4de043` | `DR` |\n| **Reply ID**| $moId, $replyId| `a175e797-2b54-468b-9850-41a3eab32f74` | `MO` `MO MMS` |\n| **Account ID** | $accountId| `DeveloperPortal7000` | `DR` `MO` `MO MMS` |\n| **Message Timestamp** | $submittedTimestamp| `2016-12-07T08:43:00.850Z` | `DR` `MO` `MO MMS` |\n| **Provider Timestamp** | $receivedTimestamp| `2016-12-07T08:44:00.850Z` | `DR` `MO` `MO MMS` |\n| **Message Status** | $status| `enroute` | `DR` |\n| **Status Code** | $statusCode| `200` | `DR` |\n| **External Metadata** | $metadata.get('key')| `name` | `DR` `MO` `MO MMS` |\n| **Source Address**| $sourceAddress| `+61491570156` | `DR` `MO` `MO MMS` |\n| **Destination Address**| $destinationAddress| `+61491593156` | `MO` `MO MMS` |\n| **Message Content**| $mtContent, $messageContent| `Hi Derp` | `DR` `MO` `MO MMS` |\n| **Reply Content**| $moContent, $replyContent| `Hello Derpina` | `MO` `MO MMS` |\n| **Retry Count**| $retryCount| `1` | `DR` `MO` `MO MMS` |\n*Note: A 400 response will be returned if the `url` is invalid, the `events`, `encoding` or `method` is null or the `headers` has a Content-Type attribute.*"
},
"response": [
{
"name": "Response_409",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"http://webhook.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"JSON\",\r\n \"headers\": {\r\n \"Account\": \"DeveloperPortal7000\"\r\n },\r\n \"events\": [\r\n \"ENROUTE_DR\",\r\n \"DELIVERED_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages"
]
},
"description": "Create a webhook for one or more of the specified events.\nA webhook would typically have the following structure:\n```\n{\n \"url\": \"http://webhook.com\",\n \"method\": \"POST\",\n \"encoding\": \"JSON\",\n \"headers\": {\n \"Account\": \"DeveloperPortal7000\"\n },\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\nA valid webhook must consist of the following properties:\n- ```url``` The configured URL which will trigger the webhook when a selected event occurs.\n- ```method``` The methods to map CRUD (create, retrieve, update, delete) operations to HTTP requests.\n- ```encoding``` Webhooks can be delivered using different content types. You can choose from ```JSON```, ```FORM_ENCODED``` or ```XML```. This will automatically add the Content-Type header for you so you don't have to add it again in the `headers` property.\n- ```headers``` HTTP header fields which provide required information about the request or response, or about the object sent in the message body. This should NOT include the `Content-Type` header.\n- ```events``` Event or events that will trigger the webhook. Atleast one event should be present.\n- ```template``` The structure of the payload that will be returned. You can format this in JSON or XML.\n#### Types of Events\nYou can select all of the events (listed below) or combine them in whatever way you like but atleast one event must be used. Otherwise, the webhook won't be created.\nA webhook will be triggered when any one or more of the events occur:\n+ **SMS**\n + `RECEIVED_SMS` Receive an SMS\n + `OPT_OUT_SMS` Opt-out occured\n+ **MMS**\n + `RECEIVED_MMS` Receive an MMS\n+ **DR (Delivery Reports)**\n + `ENROUTE_DR` Message is enroute\n + `EXPIRED_DR` Message has expired\n + `REJECTED_DR` Message is rejected\n + `FAILED_DR` Message has failed \n + `DELIVERED_DR` Message is delivered\n + `SUBMITTED_DR` Message is submitted\n#### Template Parameters\nYou can choose what to include in the data that will be sent as the payload via the Webhook. It's upto you to choose what format you would like the payload to be returned. You can choose between JSON or XML.\nKeep in my mind, if you've chosen JSON as the format, you must escape the JSON in the template value (see example above).\nThe table illustrates a list of all the parameters that can be included in the template and which event types it can be applied to.\n| Data | Parameter Name | Example | Event Type |\n|:--|--|--|--|--|\n| **Service Type** | $type| `SMS` | `DR` `MO` `MO MMS` |\n| **Message ID** | $mtId, $messageId| `877c19ef-fa2e-4cec-827a-e1df9b5509f7` | `DR` `MO` `MO MMS`|\n| **Delivery Report ID** |$drId, $reportId| `01e1fa0a-6e27-4945-9cdb-18644b4de043` | `DR` |\n| **Reply ID**| $moId, $replyId| `a175e797-2b54-468b-9850-41a3eab32f74` | `MO` `MO MMS` |\n| **Account ID** | $accountId| `DeveloperPortal7000` | `DR` `MO` `MO MMS` |\n| **Message Timestamp** | $submittedTimestamp| `2016-12-07T08:43:00.850Z` | `DR` `MO` `MO MMS` |\n| **Provider Timestamp** | $receivedTimestamp| `2016-12-07T08:44:00.850Z` | `DR` `MO` `MO MMS` |\n| **Message Status** | $status| `enroute` | `DR` |\n| **Status Code** | $statusCode| `200` | `DR` |\n| **External Metadata** | $metadata.get('key')| `name` | `DR` `MO` `MO MMS` |\n| **Source Address**| $sourceAddress| `+61491570156` | `DR` `MO` `MO MMS` |\n| **Destination Address**| $destinationAddress| `+61491593156` | `MO` `MO MMS` |\n| **Message Content**| $mtContent, $messageContent| `Hi Derp` | `DR` `MO` `MO MMS` |\n| **Reply Content**| $moContent, $replyContent| `Hello Derpina` | `MO` `MO MMS` |\n| **Retry Count**| $retryCount| `1` | `DR` `MO` `MO MMS` |\n*Note: A 400 response will be returned if the `url` is invalid, the `events`, `encoding` or `method` is null or the `headers` has a Content-Type attribute.*"
},
"status": "Unexpected error in API call. See HTTP response body for details.",
"code": 409,
"_postman_previewlanguage": "Text",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\r\n \"message\": \"A webhook with the given url and method already exists.\"\r\n}"
},
{
"name": "Response_400",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"http://webhook.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"JSON\",\r\n \"headers\": {\r\n \"Account\": \"DeveloperPortal7000\"\r\n },\r\n \"events\": [\r\n \"ENROUTE_DR\",\r\n \"DELIVERED_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages"
]
},
"description": "Create a webhook for one or more of the specified events.\nA webhook would typically have the following structure:\n```\n{\n \"url\": \"http://webhook.com\",\n \"method\": \"POST\",\n \"encoding\": \"JSON\",\n \"headers\": {\n \"Account\": \"DeveloperPortal7000\"\n },\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\nA valid webhook must consist of the following properties:\n- ```url``` The configured URL which will trigger the webhook when a selected event occurs.\n- ```method``` The methods to map CRUD (create, retrieve, update, delete) operations to HTTP requests.\n- ```encoding``` Webhooks can be delivered using different content types. You can choose from ```JSON```, ```FORM_ENCODED``` or ```XML```. This will automatically add the Content-Type header for you so you don't have to add it again in the `headers` property.\n- ```headers``` HTTP header fields which provide required information about the request or response, or about the object sent in the message body. This should NOT include the `Content-Type` header.\n- ```events``` Event or events that will trigger the webhook. Atleast one event should be present.\n- ```template``` The structure of the payload that will be returned. You can format this in JSON or XML.\n#### Types of Events\nYou can select all of the events (listed below) or combine them in whatever way you like but atleast one event must be used. Otherwise, the webhook won't be created.\nA webhook will be triggered when any one or more of the events occur:\n+ **SMS**\n + `RECEIVED_SMS` Receive an SMS\n + `OPT_OUT_SMS` Opt-out occured\n+ **MMS**\n + `RECEIVED_MMS` Receive an MMS\n+ **DR (Delivery Reports)**\n + `ENROUTE_DR` Message is enroute\n + `EXPIRED_DR` Message has expired\n + `REJECTED_DR` Message is rejected\n + `FAILED_DR` Message has failed \n + `DELIVERED_DR` Message is delivered\n + `SUBMITTED_DR` Message is submitted\n#### Template Parameters\nYou can choose what to include in the data that will be sent as the payload via the Webhook. It's upto you to choose what format you would like the payload to be returned. You can choose between JSON or XML.\nKeep in my mind, if you've chosen JSON as the format, you must escape the JSON in the template value (see example above).\nThe table illustrates a list of all the parameters that can be included in the template and which event types it can be applied to.\n| Data | Parameter Name | Example | Event Type |\n|:--|--|--|--|--|\n| **Service Type** | $type| `SMS` | `DR` `MO` `MO MMS` |\n| **Message ID** | $mtId, $messageId| `877c19ef-fa2e-4cec-827a-e1df9b5509f7` | `DR` `MO` `MO MMS`|\n| **Delivery Report ID** |$drId, $reportId| `01e1fa0a-6e27-4945-9cdb-18644b4de043` | `DR` |\n| **Reply ID**| $moId, $replyId| `a175e797-2b54-468b-9850-41a3eab32f74` | `MO` `MO MMS` |\n| **Account ID** | $accountId| `DeveloperPortal7000` | `DR` `MO` `MO MMS` |\n| **Message Timestamp** | $submittedTimestamp| `2016-12-07T08:43:00.850Z` | `DR` `MO` `MO MMS` |\n| **Provider Timestamp** | $receivedTimestamp| `2016-12-07T08:44:00.850Z` | `DR` `MO` `MO MMS` |\n| **Message Status** | $status| `enroute` | `DR` |\n| **Status Code** | $statusCode| `200` | `DR` |\n| **External Metadata** | $metadata.get('key')| `name` | `DR` `MO` `MO MMS` |\n| **Source Address**| $sourceAddress| `+61491570156` | `DR` `MO` `MO MMS` |\n| **Destination Address**| $destinationAddress| `+61491593156` | `MO` `MO MMS` |\n| **Message Content**| $mtContent, $messageContent| `Hi Derp` | `DR` `MO` `MO MMS` |\n| **Reply Content**| $moContent, $replyContent| `Hello Derpina` | `MO` `MO MMS` |\n| **Retry Count**| $retryCount| `1` | `DR` `MO` `MO MMS` |\n*Note: A 400 response will be returned if the `url` is invalid, the `events`, `encoding` or `method` is null or the `headers` has a Content-Type attribute.*"
},
"status": "Unexpected error in API call. See HTTP response body for details.",
"code": 400,
"_postman_previewlanguage": "Text",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\r\n \"message\": \"Something went wrong. Please try again later.\"\r\n}"
},
{
"name": "Response_201",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"http://webhook.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"JSON\",\r\n \"headers\": {\r\n \"Account\": \"DeveloperPortal7000\"\r\n },\r\n \"events\": [\r\n \"ENROUTE_DR\",\r\n \"DELIVERED_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages"
]
},
"description": "Create a webhook for one or more of the specified events.\nA webhook would typically have the following structure:\n```\n{\n \"url\": \"http://webhook.com\",\n \"method\": \"POST\",\n \"encoding\": \"JSON\",\n \"headers\": {\n \"Account\": \"DeveloperPortal7000\"\n },\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\",\\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\nA valid webhook must consist of the following properties:\n- ```url``` The configured URL which will trigger the webhook when a selected event occurs.\n- ```method``` The methods to map CRUD (create, retrieve, update, delete) operations to HTTP requests.\n- ```encoding``` Webhooks can be delivered using different content types. You can choose from ```JSON```, ```FORM_ENCODED``` or ```XML```. This will automatically add the Content-Type header for you so you don't have to add it again in the `headers` property.\n- ```headers``` HTTP header fields which provide required information about the request or response, or about the object sent in the message body. This should NOT include the `Content-Type` header.\n- ```events``` Event or events that will trigger the webhook. Atleast one event should be present.\n- ```template``` The structure of the payload that will be returned. You can format this in JSON or XML.\n#### Types of Events\nYou can select all of the events (listed below) or combine them in whatever way you like but atleast one event must be used. Otherwise, the webhook won't be created.\nA webhook will be triggered when any one or more of the events occur:\n+ **SMS**\n + `RECEIVED_SMS` Receive an SMS\n + `OPT_OUT_SMS` Opt-out occured\n+ **MMS**\n + `RECEIVED_MMS` Receive an MMS\n+ **DR (Delivery Reports)**\n + `ENROUTE_DR` Message is enroute\n + `EXPIRED_DR` Message has expired\n + `REJECTED_DR` Message is rejected\n + `FAILED_DR` Message has failed \n + `DELIVERED_DR` Message is delivered\n + `SUBMITTED_DR` Message is submitted\n#### Template Parameters\nYou can choose what to include in the data that will be sent as the payload via the Webhook. It's upto you to choose what format you would like the payload to be returned. You can choose between JSON or XML.\nKeep in my mind, if you've chosen JSON as the format, you must escape the JSON in the template value (see example above).\nThe table illustrates a list of all the parameters that can be included in the template and which event types it can be applied to.\n| Data | Parameter Name | Example | Event Type |\n|:--|--|--|--|--|\n| **Service Type** | $type| `SMS` | `DR` `MO` `MO MMS` |\n| **Message ID** | $mtId, $messageId| `877c19ef-fa2e-4cec-827a-e1df9b5509f7` | `DR` `MO` `MO MMS`|\n| **Delivery Report ID** |$drId, $reportId| `01e1fa0a-6e27-4945-9cdb-18644b4de043` | `DR` |\n| **Reply ID**| $moId, $replyId| `a175e797-2b54-468b-9850-41a3eab32f74` | `MO` `MO MMS` |\n| **Account ID** | $accountId| `DeveloperPortal7000` | `DR` `MO` `MO MMS` |\n| **Message Timestamp** | $submittedTimestamp| `2016-12-07T08:43:00.850Z` | `DR` `MO` `MO MMS` |\n| **Provider Timestamp** | $receivedTimestamp| `2016-12-07T08:44:00.850Z` | `DR` `MO` `MO MMS` |\n| **Message Status** | $status| `enroute` | `DR` |\n| **Status Code** | $statusCode| `200` | `DR` |\n| **External Metadata** | $metadata.get('key')| `name` | `DR` `MO` `MO MMS` |\n| **Source Address**| $sourceAddress| `+61491570156` | `DR` `MO` `MO MMS` |\n| **Destination Address**| $destinationAddress| `+61491593156` | `MO` `MO MMS` |\n| **Message Content**| $mtContent, $messageContent| `Hi Derp` | `DR` `MO` `MO MMS` |\n| **Reply Content**| $moContent, $replyContent| `Hello Derpina` | `MO` `MO MMS` |\n| **Retry Count**| $retryCount| `1` | `DR` `MO` `MO MMS` |\n*Note: A 400 response will be returned if the `url` is invalid, the `events`, `encoding` or `method` is null or the `headers` has a Content-Type attribute.*"
},
"status": "Webhook successfully created",
"code": 201,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
}
]
},
{
"name": "Retrieve Webhook",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/?page=%270%27&pageSize=%2710%27",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
""
],
"query": [
{
"key": "page",
"value": "%270%27"
},
{
"key": "pageSize",
"value": "%2710%27"
}
]
},
"description": "Retrieve all the webhooks created for the connected account.\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"page\": 0,\n \"pageSize\": 100,\n \"pageData\": [\n {\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"8805c9d8-bef7-41c7-906a-69ede93aa024\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n }\n ]\n}\n```\n*Note: Response 400 is returned when the `page` query parameter is not valid or the `pageSize` query parameter is not valid.*"
},
"response": [
{
"name": "Response_200",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/?page=%270%27&pageSize=%2710%27",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
""
],
"query": [
{
"key": "page",
"value": "%270%27"
},
{
"key": "pageSize",
"value": "%2710%27"
}
]
},
"description": "Retrieve all the webhooks created for the connected account.\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"page\": 0,\n \"pageSize\": 100,\n \"pageData\": [\n {\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"8805c9d8-bef7-41c7-906a-69ede93aa024\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n }\n ]\n}\n```\n*Note: Response 400 is returned when the `page` query parameter is not valid or the `pageSize` query parameter is not valid.*"
},
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Response_400",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/?page=%270%27&pageSize=%2710%27",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
""
],
"query": [
{
"key": "page",
"value": "%270%27"
},
{
"key": "pageSize",
"value": "%2710%27"
}
]
},
"description": "Retrieve all the webhooks created for the connected account.\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"page\": 0,\n \"pageSize\": 100,\n \"pageData\": [\n {\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"8805c9d8-bef7-41c7-906a-69ede93aa024\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n }\n ]\n}\n```\n*Note: Response 400 is returned when the `page` query parameter is not valid or the `pageSize` query parameter is not valid.*"
},
"status": "Unexpected error in API call. See HTTP response body for details.",
"code": 400,
"_postman_previewlanguage": "Text",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\r\n \"message\": \"Something went wrong. Please try again later.\"\r\n}"
}
]
},
{
"name": "Delete Webhook",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "*/*"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Delete a webhook that was previously created for the connected account.\nA webhook can be cancelled by appending the UUID of the webhook to the endpoint and submitting a DELETE request to the /webhooks/messages endpoint.\nA successful request to the retrieve webhook endpoint will return a null response.\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"response": [
{
"name": "Response_404",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "*/*"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Delete a webhook that was previously created for the connected account.\nA webhook can be cancelled by appending the UUID of the webhook to the endpoint and submitting a DELETE request to the /webhooks/messages endpoint.\nA successful request to the retrieve webhook endpoint will return a null response.\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"code": 404,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Response_204",
"originalRequest": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "*/*"
}
],
"body": {
"mode": "raw",
"raw": ""
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Delete a webhook that was previously created for the connected account.\nA webhook can be cancelled by appending the UUID of the webhook to the endpoint and submitting a DELETE request to the /webhooks/messages endpoint.\nA successful request to the retrieve webhook endpoint will return a null response.\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"status": "Webhook deleted successfully",
"code": 204,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
}
]
},
{
"name": "Update Webhook",
"request": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://myurl.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"FORM_ENCODED\",\r\n \"events\": [\r\n \"ENROUTE_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Update a webhook. You can update individual attributes or all of them by submitting a PATCH request to the /webhooks/messages endpoint (the same endpoint used above to delete a webhook)\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"04442623-0961-464e-9cbc-ec50804e0413\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"response": [
{
"name": "Response_200",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://myurl.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"FORM_ENCODED\",\r\n \"events\": [\r\n \"ENROUTE_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Update a webhook. You can update individual attributes or all of them by submitting a PATCH request to the /webhooks/messages endpoint (the same endpoint used above to delete a webhook)\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"04442623-0961-464e-9cbc-ec50804e0413\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"status": "Webhook updated successfully",
"code": 200,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
},
{
"name": "Response_400",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://myurl.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"FORM_ENCODED\",\r\n \"events\": [\r\n \"ENROUTE_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Update a webhook. You can update individual attributes or all of them by submitting a PATCH request to the /webhooks/messages endpoint (the same endpoint used above to delete a webhook)\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"04442623-0961-464e-9cbc-ec50804e0413\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"status": "Unexpected error in API call. See HTTP response body for details.",
"code": 400,
"_postman_previewlanguage": "Text",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [],
"body": "{\r\n \"message\": \"Something went wrong. Please try again later.\"\r\n}"
},
{
"name": "Response_404",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\r\n \"url\": \"https://myurl.com\",\r\n \"method\": \"POST\",\r\n \"encoding\": \"FORM_ENCODED\",\r\n \"events\": [\r\n \"ENROUTE_DR\"\r\n ],\r\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\r\n}"
},
"url": {
"raw": "https://api.messagemedia.com/v1/webhooks/messages/:webhookId",
"protocol": "https",
"host": [
"api",
"messagemedia",
"com"
],
"path": [
"v1",
"webhooks",
"messages",
":webhookId"
],
"variable": [
{
"key": "webhookId",
"value": "a7f11bb0-f299-4861-a5ca-9b29d04bc5ad"
}
]
},
"description": "Update a webhook. You can update individual attributes or all of them by submitting a PATCH request to the /webhooks/messages endpoint (the same endpoint used above to delete a webhook)\nA successful request to the retrieve webhook endpoint will return a response body as follows:\n```\n{\n \"url\": \"https://webhook.com\",\n \"method\": \"POST\",\n \"id\": \"04442623-0961-464e-9cbc-ec50804e0413\",\n \"encoding\": \"JSON\",\n \"events\": [\n \"RECEIVED_SMS\"\n ],\n \"headers\": {},\n \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"\n}\n```\n*Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*"
},
"code": 404,
"_postman_previewlanguage": "Text",
"header": [],
"cookie": [],
"body": ""
}
]
}
]
}
]
}