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 1d5b41a

Browse files
Update README.md
1 parent da35c1d commit 1d5b41a

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 C# SDK
22
[![Travis Build Status](https://api.travis-ci.org/messagemedia/webhooks-csharp-sdk.svg?branch=master)](https://travis-ci.org/messagemedia/webhooks-csharp-sdk)
3+
[![Pull Requests Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat)](http://makeapullrequest.com)
34
[![NuGet version](https://badge.fury.io/nu/MessageMedia.SDK.Webhooks.svg)](https://badge.fury.io/nu/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 Nuget
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
Install via NuGet by:
963

1064
PM> ```Install-Package MessageMedia.SDK.Webhooks```
@@ -14,10 +68,10 @@ Alternatively, right-click on your solution and click "Manage NuGet Packages..."
1468
Visual Studio Mac:
1569
Project -> Add NuGet Packages -> Search for 'MessageMedia'
1670

17-
## 🎬 Get Started
71+
## :clapper: Get Started
1872
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.
1973

20-
### πŸš€ Create a webhook
74+
### Create a webhook
2175
```csharp
2276
using System;
2377
using MessageMedia.Webhooks;
@@ -58,7 +112,7 @@ namespace TestApp
58112

59113
```
60114

61-
### πŸ“₯ Retrieve all webhooks
115+
### Retrieve all webhooks
62116
```csharp
63117
using System;
64118
using MessageMedia.Webhooks;
@@ -93,7 +147,7 @@ namespace TestApp
93147

94148
```
95149

96-
### πŸ”„ Update a webhook
150+
### Update a webhook
97151
You can get a webhook ID by looking at the `id` of each webhook created from the response of the above example.
98152
```csharp
99153
using System;
@@ -138,7 +192,7 @@ namespace TestApp
138192

139193
```
140194

141-
### ❌ Delete a webhook
195+
### Delete a webhook
142196
You can get a webhook ID by looking at the `id` of each webhook created from the response of the retrieve webhooks example.
143197
```csharp
144198
using System;
@@ -170,11 +224,11 @@ namespace TestApp
170224

171225
```
172226

173-
## πŸ“• Documentation
174-
Check out the [full API documentation](DOCUMENTATION.md) for more detailed information.
227+
## :closed_book: API Reference Documentation
228+
Check out the [full API documentation](https://developers.messagemedia.com/code/webhooks-api-documentation/) for more detailed information.
175229

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

179-
## πŸ“ƒ License
233+
## :page_with_curl: License
180234
Apache License. See the [LICENSE](LICENSE) file.

0 commit comments

Comments
(0)

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