https://github.com/messagemedia/webhooks-java-sdk
MessageMedia Java SDK for webhooks
https://github.com/messagemedia/webhooks-java-sdk
java messagemedia messaging sms sms-api sms-client sms-gateway sms-messages webhooks webhooks-api
Last synced: 7 months ago
JSON representation
MessageMedia Java SDK for webhooks
- Host: GitHub
- URL: https://github.com/messagemedia/webhooks-java-sdk
- Owner: messagemedia
- License: apache-2.0
- Created: 2018-05-03T05:52:06.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-07-07T10:35:21.000Z (over 7 years ago)
- Last Synced: 2025-04-02T02:46:32.378Z (11 months ago)
- Topics: java, messagemedia, messaging, sms, sms-api, sms-client, sms-gateway, sms-messages, webhooks, webhooks-api
- Language: Java
- Homepage: https://developers.messagemedia.com/
- Size: 137 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MessageMedia Webhooks Java SDK
[](https://travis-ci.org/messagemedia/webhooks-java-sdk)
[](http://makeapullrequest.com)
[](https://mvnrepository.com/artifact/com.messagemedia.sdk/webhooks)
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.
## Table of Contents
* [Authentication](#closed_lock_with_key-authentication)
* [Errors](#interrobang-errors)
* [Information](#newspaper-information)
* [Slack and Mailing List](#slack-and-mailing-list)
* [Bug Reports](#bug-reports)
* [Contributing](#contributing)
* [Installation](#star-installation)
* [Get Started](#clapper-get-started)
* [API Documentation](#closed_book-api-documentation)
* [Need help?](#confused-need-help)
* [License](#page_with_curl-license)
## :closed_lock_with_key: Authentication
Authentication is done via API keys. Sign up at https://developers.messagemedia.com/register/ to get your API keys.
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.
## :interrobang: Errors
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.
#### HTTP Status Codes
| Code | Title | Description |
|-----------|-------------|-------------|
| 400 | Invalid Request | The request was invalid |
| 401 | Unauthorized | Your API credentials are invalid |
| 403 | Disabled feature | Feature not enabled |
| 404 | Not Found | The resource does not exist |
| 50X | Internal Server Error | An error occurred with our API |
## :newspaper: Information
#### Slack and Mailing List
If you have any questions, comments, or concerns, please join our Slack channel:
https://developers.messagemedia.com/collaborate/slack/
Alternatively you can email us at:
developers@messagemedia.com
#### Bug reports
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
#### Contributing
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)
## :star: Installation
At present the jars are available from a public maven repository.
Use the following dependency in your project to grab via Maven:
```
com.messagemedia.sdk
webhooks
1.0.0
```
## :clapper: Get Started
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.
### Create a webhook
```java
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.messagemedia.webhooks.MessageMediaWebhooksClient;
import com.messagemedia.webhooks.controllers.WebhooksController;
import com.messagemedia.webhooks.models.CreateWebhookRequest;
public class Main {
public static void main(String[] args) throws Throwable {
// Configuration parameters and credentials
String basicAuthUserName = "API_KEY"; // The username to use with basic authentication
String basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
MessageMediaWebhooksClient client = new MessageMediaWebhooksClient(basicAuthUserName, basicAuthPassword);
WebhooksController webhooks = client.getWebhooks();
String bodyValue = "{\"url\": \"https://webhook.com\"," +
"\"method\": \"POST\"," +
"\"encoding\": \"JSON\"," +
"\"events\": [ \"RECEIVED_SMS\" ]," +
"\"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"" +
"}";
ObjectMapper mapper = new ObjectMapper();
CreateWebhookRequest body = mapper.readValue(bodyValue,new TypeReference(){});
webhooks.createWebhook(body);
}
}
```
### Retrieve all webhooks
```java
import com.fasterxml.jackson.core.type.TypeReference;
import com.messagemedia.webhooks.MessageMediaWebhooksClient;
import com.messagemedia.webhooks.controllers.WebhooksController;
public class Main {
public static void main(String[] args) throws Throwable {
// Configuration parameters and credentials
String basicAuthUserName = "API_KEY"; // The username to use with basic authentication
String basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
MessageMediaWebhooksClient client = new MessageMediaWebhooksClient(basicAuthUserName, basicAuthPassword);
WebhooksController webhooks = client.getWebhooks();
Integer page = 0;
Integer pageSize = 0;
String result = (webhooks.retrieveWebhook(page, pageSize).parseAsString());
System.out.print(result);
}
}
```
### Update a webhook
You can get a webhook ID by looking at the `id` of each webhook created from the response of the above example.
```java
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.messagemedia.webhooks.MessageMediaWebhooksClient;
import com.messagemedia.webhooks.controllers.WebhooksController;
import com.messagemedia.webhooks.models.UpdateWebhookRequest;
public class Main {
public static void main(String[] args) throws Throwable {
// Configuration parameters and credentials
String basicAuthUserName = "API_KEY"; // The username to use with basic authentication
String basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
MessageMediaWebhooksClient client = new MessageMediaWebhooksClient(basicAuthUserName, basicAuthPassword);
WebhooksController webhooks = client.getWebhooks();
String webhookId = "WEBHOOK_ID";
String bodyValue = "{\"url\": \"https://myurl.com\"," +
"\"method\": \"POST\"," +
"\"encoding\": \"JSON\"," +
"\"events\": [ \"ENROUTE_DR\" ]," +
"\"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"" +
"}";
ObjectMapper mapper = new ObjectMapper();
UpdateWebhookRequest body = mapper.readValue(bodyValue,new TypeReference(){});
webhooks.updateWebhook(webhookId, body);
}
}
```
### Delete a webhook
You can get a webhook ID by looking at the `id` of each webhook created from the response of the retrieve webhooks example.
```java
import com.fasterxml.jackson.core.type.TypeReference;
import com.messagemedia.webhooks.MessageMediaWebhooksClient;
import com.messagemedia.webhooks.controllers.WebhooksController;
public class Main {
public static void main(String[] args) throws Throwable {
// Configuration parameters and credentials
String basicAuthUserName = "API_KEY"; // The username to use with basic authentication
String basicAuthPassword = "API_SECRET"; // The password to use with basic authentication
MessageMediaWebhooksClient client = new MessageMediaWebhooksClient(basicAuthUserName, basicAuthPassword);
WebhooksController webhooks = client.getWebhooks();
String webhookId = "WEBHOOK_ID";
webhooks.deleteWebhook(webhookId);
}
}
```
## :closed_book: API Reference Documentation
Check out the [full API documentation](https://developers.messagemedia.com/code/webhooks-api-documentation/) for more detailed information.
## :confused: Need help?
Please contact developer support at developers@messagemedia.com or check out the developer portal at [developers.messagemedia.com](https://developers.messagemedia.com/)
## :page_with_curl: License
Apache License. See the [LICENSE](LICENSE) file.