MessageMedia Webhooks NodeJS SDK

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.

⭐️ Installing via RubyGems

Run the following command to install the SDK via RubyGems:

gem install messagemedia-webhooks-sdk

🎬 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

require 'message_media_webhooks'
require 'pp'

# Configuration parameters and credentials
basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
basic_auth_password = 'API_SECRET' # The password to use with basic authentication

client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
  basic_auth_user_name: basic_auth_user_name,
  basic_auth_password: basic_auth_password
)

webhooks_controller = client.webhooks

body = MessageMediaWebhooks::CreateWebhookRequest.new("http://webhook2.com",
  "POST",
  "JSON",
  nil,
  ["ENROUTE_DR"],
  "{\"id\":\"$mtId\",\"status\":\"$statusCode\"}"
)

result = webhooks_controller.create_webhook(body)
pp result

📥 Retrieve all webhooks

require 'message_media_webhooks'
require 'pp'

# Configuration parameters and credentials
basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
basic_auth_password = 'API_SECRET' # The password to use with basic authentication

client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
  basic_auth_user_name: basic_auth_user_name,
  basic_auth_password: basic_auth_password
)

webhooks_controller = client.webhooks

page = 0
page_size = 0

result = webhooks_controller.retrieve_webhook(page, page_size)
pp 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.

require 'message_media_webhooks'
require 'pp'

# Configuration parameters and credentials
basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
basic_auth_password = 'API_SECRET' # The password to use with basic authentication

client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
  basic_auth_user_name: basic_auth_user_name,
  basic_auth_password: basic_auth_password
)

webhooks_controller = client.webhooks

webhook_id = "WEBHOOK_ID"

body_value = "{
  \"url\": \"https://myurl.com\",        
  \"method\": \"POST\",        
  \"encoding\": \"FORM_ENCODED\",        
  \"events\": [\"ENROUTE_DR\"],        
  \"template\": \"{\\\"id\\\":\\\"$mtId\\\", \\\"status\\\":\\\"$statusCode\\\"}\"    
}";

body = JSON.parse(body_value);

result = webhooks_controller.update_webhook(webhook_id, body)
pp result

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

require 'message_media_webhooks'
require 'pp'

# Configuration parameters and credentials
basic_auth_user_name = 'API_KEY' # The username to use with basic authentication
basic_auth_password = 'API_SECRET' # The password to use with basic authentication

client = MessageMediaWebhooks::MessageMediaWebhooksClient.new(
  basic_auth_user_name: basic_auth_user_name,
  basic_auth_password: basic_auth_password
)

webhooks_controller = client.webhooks

webhook_id = "WEBHOOK_ID"

webhooks_controller.delete_webhook(webhook_id)
pp result

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