MessageMedia NodeJS SDK for webhooks
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
lib
test
.travis.yml
DOCUMENTATION.md
Jenkinsfile
LICENSE
README.md
appveyor.yml
circle.yml
package.json

README.md

MessageMedia Webhooks NodeJS SDK

Travis Build Status Pull Requests Welcome npm version

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.

Webhooks Flow

Table of Contents

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

⁉️ 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

📰 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 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

⭐️ Installation

Now install messagemedia-messages-sdk via npm by using:

npm install messagemedia-webhooks-sdk

Alternatively, add the following to the dependencies section of your package.json:

"messagemedia-webhooks-sdk": "^1.0.0"

🎬 Get Started

It's easy to get started. Simply enter the API Key and secret you obtained from the MessageMedia Developers Portal into the code snippet below.

Create a webhook

const lib = require('messagemedia-webhooks-sdk');

// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication

var controller = lib.WebhooksController;

var body = new lib.CreateWebhookRequest({
    "url": "http://webhook.com",
    "method": "POST",
    "encoding": "JSON",
    "events": [
        "RECEIVED_SMS"
    ],
    "template": "{\"id\":\"$mtId\",\"status\":\"$statusCode\"}"
});

controller.createWebhook(body, function(error, response, context) {
    console.log(response);
});

Retrieve all webhooks

const lib = require('messagemedia-webhooks-sdk');

// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication

var controller = lib.WebhooksController;

var page = 0;
var pageSize = 0;

controller.retrieveWebhook(page, pageSize, function(error, response, context) {
    console.log(response);
});

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.

const lib = require('messagemedia-webhooks-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication

var controller = lib.WebhooksController;

var webhookId = "WEBHOOK_ID";

var body = new lib.UpdateWebhookRequest({
    "url": "https://myurl.com",
    "method": "POST",
    "encoding": "FORM_ENCODED",
    "events": [
        "ENROUTE_DR"
    ],
    "template": "{\"id\":\"$mtId\", \"status\":\"$statusCode\"}"
});

controller.updateWebhook(webhookId, body, function(error, response, context) {
    console.log(response);
});

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.

const lib = require('messagemedia-webhooks-sdk');
// Configuration parameters and credentials
lib.Configuration.basicAuthUserName = "API_KEY"; // The username to use with basic authentication
lib.Configuration.basicAuthPassword = "API_SECRET"; // The password to use with basic authentication

var controller = lib.WebhooksController;

var webhookId = "WEBHOOK_ID";

controller.deleteWebhook(webhookId, function(error, response, context) {
    console.log(response);
});

📕 API Reference Documentation

Check out the full API documentation for more detailed information.

😕 Need help?

Please contact developer support at developers@messagemedia.com or check out the developer portal at developers.messagemedia.com

📃 License

Apache License. See the LICENSE file.