Skip to content

Commit 97a3550

Browse files
authored
Update README.md
1 parent f32c6de commit 97a3550

File tree

1 file changed

+67
-11
lines changed

1 file changed

+67
-11
lines changed

β€ŽREADME.md

+67-11
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,73 @@
11
# MessageMedia Webhooks Python SDK
22
[![Travis Build Status](https://api.travis-ci.org/messagemedia/webhooks-python-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/webhooks-python-sdk)
3+
[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
34
[![PyPI](https://badge.fury.io/py/messagemedia-webhooks-sdk.svg)](https://pypi.python.org/pypi/messagemedia-webhooks-sdk)
45

56
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.
67

7-
## ⭐️ Install via PIP
8+
![Webhooks Flow](http://i66.tinypic.com/2ufxf81.jpg)
9+
10+
## Table of Contents
11+
* [Authentication](#closed_lock_with_key-authentication)
12+
* [Errors](#interrobang-errors)
13+
* [Information](#newspaper-information)
14+
* [Slack and Mailing List](#slack-and-mailing-list)
15+
* [Bug Reports](#bug-reports)
16+
* [Contributing](#contributing)
17+
* [Installation](#star-installation)
18+
* [Get Started](#clapper-get-started)
19+
* [API Documentation](#closed_book-api-documentation)
20+
* [Need help?](#confused-need-help)
21+
* [License](#page_with_curl-license)
22+
23+
## :closed_lock_with_key: Authentication
24+
25+
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:
48+
https://developers.messagemedia.com/collaborate/slack/
49+
50+
Alternatively you can email us at:
51+
52+
53+
#### Bug reports
54+
55+
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
862
Run the following command to install the SDK via pip:
9-
`pip install messagemedia-webhooks-sdk`
63+
```
64+
pip install messagemedia-webhooks-sdk
65+
```
1066

11-
## 🎬 Get Started
67+
## :clapper: Get Started
1268
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.
1369

14-
### πŸš€ Create a webhook
70+
### Create a webhook
1571
```python
1672
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
1773
from message_media_webhooks.models.create_webhook_request import CreateWebhookRequest
@@ -28,7 +84,7 @@ result = webhooks_controller.create_webhook(body)
2884

2985
```
3086

31-
### πŸ“₯ Retrieve all webhooks
87+
### Retrieve all webhooks
3288
```python
3389
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
3490
from message_media_webhooks.models.create_webhook_request import CreateWebhookRequest
@@ -46,7 +102,7 @@ result = webhooks_controller.retrieve_webhook(page, page_size)
46102

47103
```
48104

49-
### πŸ”„ Update a webhook
105+
### Update a webhook
50106
You can get a webhook ID by looking at the `id` of each webhook created from the response of the above example.
51107
```python
52108
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
@@ -67,7 +123,7 @@ result = webhooks_controller.update_webhook(webhook_id, body)
67123

68124
```
69125

70-
### ❌ Delete a webhook
126+
### Delete a webhook
71127
You can get a webhook ID by looking at the `id` of each webhook created from the response of the retrieve webhooks example.
72128
```python
73129
from message_media_webhooks.message_media_webhooks_client import MessageMediaWebhooksClient
@@ -85,11 +141,11 @@ result = webhooks_controller.create_webhook(body)
85141

86142
```
87143

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.
90146

91-
## πŸ˜• Need help?
147+
## :confused: Need help?
92148
Please contact developer support at [email protected] or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
93149

94-
## πŸ“ƒ License
150+
## :page_with_curl: License
95151
Apache License. See the [LICENSE](LICENSE) file.

0 commit comments

Comments
Β (0)