Skip to main content

Creating a Subscription

You can subscribe to Equinix Messaging Gateway (EMG) in a self-serviceable way and integrate with Platform Equinix over event-based channels.

Prerequisites​

  • You have valid user credentials to access the Customer Portal.
  • You must have the required permissions to order and receive Messaging Gateway notifications.

Access Developer Settings​

  1. Sign in to the Customer Portal.

  2. From the global navigation menu, select Developer Settings > Messaging Gateway.

note

Before using the platform and APIs for the first time, you must read and accept the displayed API license agreement.

Once you have accepted the agreement, you can find it in the Additional Information section.

Create a Subscription​

  1. Click Create New Subscription.

  2. Enter a Subscription Name.

  3. Choose an integration environment for your subscription:

    • Sandbox — select if you are conducting integration testing with EMG. It is a global mock test environment to simulate Equinix production behavior.
    • Production — select if you want to integrate your subscription into a live, production setting.

    note

    You are limited to one active subscription per environment.

Choose Notification Types​

Select the products and services that you want to receive EMG notifications for.

  • Billing Notifications - Receive notifications when your submitted order is closed, and Equinix starts billing.
  • IBX Notifications - Receive notifications for any planned and unplanned maintenance at data center locations, such as Advisory, Incidents, Maintenance, or Security Incidents.
  • Fabric Notifications - Receive notifications for Fabric port and provisioned virtual connections.
  • Network Notifications - Receive notifications for network incidents and maintenance.
  • Non-EMG Order Notifications - Receive notifications for orders placed in the and Customer Portal and Equinix API. Choose Yes if you want to get these notifications.

note

Some notification types may not be available if you do not have the correct permissions.

If you are unaware of your user permissions or need access to some Equinix products and services, contact your Primary Administrator.

Click Next.

Choose an Authentication Method​

Messaging Gateway offers two types of authentication:

  • Access Token
  • Signed Certificate

For detailed information, refer to Access and Authentication.

  • Access Token - If you opt for access token authentication, you can use an existing app or create a new one.

  • Signed Certificate - If you opt for certificate-based authentication, you can provide certificate details (primary and secondary public keys).

Click Next.

Verify Subscription Summary​

Check the subscription summary. Before you create a subscription, you can edit subscription details and authentication.

Activate Subscription​

Once you verify all data, click Create to create a new subscription.

The newly created subscription is listed in the My Subscriptions list.

Subscribing​

Once you have created a subscription, you can find its configuration from the Subscription Details, on the Configuration tab.

  • Click Copy YAML to copy the YAML file with your subscription details.

  • Download Messaging Gateway templates from the /equinix/messaging-gateway-templates repository, available in Java, Node.js and Python under MIT License. Use the yaml configuration file to update the configuration file available under /config in a template.

  • Refer/extend/update EMG templates as per your organization architecture and security policies, and start sending & receiving events from EMG for the subscribed features.

If you are not able to view or copy the YAML file, reach out to the member of your organization who has created the configuration. You can get his/her email address by referring the email address available in the Created By field.