Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 4dca546

Browse files
Update README.md
1 parent 21d0a18 commit 4dca546

File tree

1 file changed

+64
-10
lines changed

1 file changed

+64
-10
lines changed

β€ŽREADME.md

Lines changed: 64 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,64 @@
11
# MessageMedia Webhooks Java SDK
22
[![Travis Build Status](https://api.travis-ci.org/messagemedia/webhooks-java-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/webhooks-java-sdk)
3+
[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
34
[![maven](https://img.shields.io/maven-metadata/v/http/central.maven.org/maven2/com/messagemedia/sdk/webhooks/maven-metadata.xml.svg)](https://mvnrepository.com/artifact/com.messagemedia.sdk/webhooks)
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-
## ⭐️ Installing via Maven
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+
developers@messagemedia.com
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: developers@messagemedia.com
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
At present the jars are available from a public maven repository.
963

1064
Use the following dependency in your project to grab via Maven:
@@ -17,10 +71,10 @@ Use the following dependency in your project to grab via Maven:
1771
1872
```
1973

20-
## 🎬 Get Started
74+
## :clapper: Get Started
2175
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.
2276

23-
### πŸš€ Create a webhook
77+
### Create a webhook
2478
```java
2579
import com.fasterxml.jackson.core.type.TypeReference;
2680
import com.fasterxml.jackson.databind.ObjectMapper;
@@ -55,7 +109,7 @@ public class Main {
55109

56110
```
57111

58-
### πŸ“₯ Retrieve all webhooks
112+
### Retrieve all webhooks
59113
```java
60114
import com.fasterxml.jackson.core.type.TypeReference;
61115
import com.messagemedia.webhooks.MessageMediaWebhooksClient;
@@ -82,7 +136,7 @@ public class Main {
82136

83137
```
84138

85-
### πŸ”„ Update a webhook
139+
### Update a webhook
86140
You can get a webhook ID by looking at the `id` of each webhook created from the response of the above example.
87141
```java
88142
import com.fasterxml.jackson.core.type.TypeReference;
@@ -120,7 +174,7 @@ public class Main {
120174

121175
```
122176

123-
### ❌ Delete a webhook
177+
### Delete a webhook
124178
You can get a webhook ID by looking at the `id` of each webhook created from the response of the retrieve webhooks example.
125179
```java
126180
import com.fasterxml.jackson.core.type.TypeReference;
@@ -146,11 +200,11 @@ public class Main {
146200

147201
```
148202

149-
## πŸ“• Documentation
150-
Check out the [full API documentation](DOCUMENTATION.md) for more detailed information.
203+
## :closed_book: API Reference Documentation
204+
Check out the [full API documentation](https://developers.messagemedia.com/code/webhooks-api-documentation/) for more detailed information.
151205

152-
## πŸ˜• Need help?
206+
## :confused: Need help?
153207
Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
154208

155-
## πŸ“ƒ License
209+
## :page_with_curl: License
156210
Apache License. See the [LICENSE](LICENSE) file.

0 commit comments

Comments
(0)

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /