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: 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
8
62
At present the jars are available from a public maven repository.
9
63
10
64
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:
17
71
18
72
```
19
73
20
-
## π¬ Get Started
74
+
## :clapper: Get Started
21
75
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.
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.
151
205
152
-
## π Need help?
206
+
## :confused: Need help?
153
207
Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
0 commit comments