npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

messagemedia-webhooks-sdk

v1.0.0

Published

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.

Downloads

7

Readme

MessageMedia Webhooks NodeJS SDK

Travis Build Status npm

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.

⭐️ Installing via NPM

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 and a mobile number you wish to send to.

🚀 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);
});

📕 Documentation

Check out the full API documentation for more detailed information.

😕 Need help?

Please contact developer support at [email protected] or check out the developer portal at developers.messagemedia.com

📃 License

Apache License. See the LICENSE file.