You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The MessageMedia Webhooks allows you to subscribe to one or several events and when one of those events is triggered, an HTTP request is sent to the URL of your choice along with the message or payload. In simpler terms, it allows applications to "speak" to one another and get notified automatically when something new happens.
Authentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.
26
+
27
+
Requests are authenticated using HTTP Basic Auth or HMAC. Provide your API key as the auth_user_name and API secret as the auth_password.
28
+
29
+
## :interrobang: Errors
30
+
31
+
Our API returns standard HTTP success or error status codes. For errors, we will also include extra information about what went wrong encoded in the response as JSON. The most common status codes are listed below.
32
+
33
+
#### HTTP Status Codes
34
+
35
+
| Code | Title | Description |
36
+
|-----------|-------------|-------------|
37
+
| 400 | Invalid Request | The request was invalid |
38
+
| 401 | Unauthorized | Your API credentials are invalid |
39
+
| 403 | Disabled feature | Feature not enabled |
40
+
| 404 | Not Found | The resource does not exist |
41
+
| 50X | Internal Server Error | An error occurred with our API |
42
+
43
+
## :newspaper: Information
44
+
45
+
#### Slack and Mailing List
46
+
47
+
If you have any questions, comments, or concerns, please join our Slack channel:
If you discover a problem with the SDK, we would like to know about it. You can raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues) or send an email to: [email protected]
56
+
57
+
#### Contributing
58
+
59
+
We welcome your thoughts on how we could best provide you with SDKs that would simplify how you consume our services in your application. You can fork and create pull requests for any features you would like to see or raise an [issue](https://github.com/messagemedia/signingkeys-nodejs-sdk/issues)
60
+
61
+
## :star: Installation
8
62
Run the following command to install the SDK via pip:
9
-
`pip install messagemedia-webhooks-sdk`
63
+
```
64
+
pip install messagemedia-webhooks-sdk
65
+
```
10
66
11
-
## π¬ Get Started
67
+
## :clapper: Get Started
12
68
It's easy to get started. Simply enter the API Key and secret you obtained from the [MessageMedia Developers Portal](https://developers.messagemedia.com) into the code snippet below.
13
69
14
-
### π Create a webhook
70
+
### Create a webhook
15
71
```python
16
72
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
17
73
from message_media_webhooks.models.create_webhook_request import CreateWebhookRequest
@@ -28,7 +84,7 @@ result = webhooks_controller.create_webhook(body)
28
84
29
85
```
30
86
31
-
### π₯ Retrieve all webhooks
87
+
### Retrieve all webhooks
32
88
```python
33
89
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
34
90
from message_media_webhooks.models.create_webhook_request import CreateWebhookRequest
@@ -46,7 +102,7 @@ result = webhooks_controller.retrieve_webhook(page, page_size)
46
102
47
103
```
48
104
49
-
### π Update a webhook
105
+
### Update a webhook
50
106
You can get a webhook ID by looking at the `id` of each webhook created from the response of the above example.
51
107
```python
52
108
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
@@ -67,7 +123,7 @@ result = webhooks_controller.update_webhook(webhook_id, body)
67
123
68
124
```
69
125
70
-
### β Delete a webhook
126
+
### Delete a webhook
71
127
You can get a webhook ID by looking at the `id` of each webhook created from the response of the retrieve webhooks example.
72
128
```python
73
129
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
@@ -85,11 +141,11 @@ result = webhooks_controller.create_webhook(body)
85
141
86
142
```
87
143
88
-
## π Documentation
89
-
Check out the [full API documentation](DOCUMENTATION.md) for more detailed information.
144
+
## :closed_book: API Reference Documentation
145
+
Check out the [full API documentation](https://developers.messagemedia.com/code/webhooks-api-documentation/) for more detailed information.
90
146
91
-
## π Need help?
147
+
## :confused: Need help?
92
148
Please contact developer support at [email protected] or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
0 commit comments