Getting Started Guide

Welcome to the Everbridge Suite API Getting Started Guide.

• Authenticate to our REST APIs and the types of supported authentication methods
• Create authentication credentials
• Common Error Messages
• Throttling policies
• How to contact support
• Where to go to begin learning and using the Everbridge Suite APIs

If you want to test our the Everbridge APIs, the first thing you will need are your “credentials” Please see our Authentication Types documentation for all supported methods. We recommend using OAuth 2.0 Authentication.

📘

Currently OAuth Self-Service Workflow for the Everbridge Suite REST APIs must be enabled by your Account Manager.

*Note: There is NO Additional Charge to use this method of API Authentication

The Everbridge Suite REST APIs currently only support the Password grant type for OAuth 2.0. As such you will need to create two sets of credentials for authenticating

• Username & Password
• Client ID & Client Secret

The Safety Device APIs currently only support the Client Credential grant type for OAuth 2.0. As such you will need only one set of credentials which will be delivered to you via your account manager upon enablement

Service Account Client Credentials can be created and managed at the Account and the Organization level by their respective administrators. We currently allow 5 accounts created at the account level and 5 accounts at each Organization level.

📘

A good rule of thumb is to create separate service account for each integration within the specific organization you are integrating against, unless the APIs are Account level APIs as are the case with User and Audit Log APIs.

1. In the Everbrige Manager Portal, navigate to either
   • Users → Service Accounts from the Account level
   
   • Settings → Access →Service Account from the Organization level

1. Press the Create Service Account button located in the top left corner of the screen
2. Select from the radio button options if you are creating an Account or Organization level Service Account
   1. Enter the Account Name and select the organization(s) this account will be allowed to access.
   2. Click Save
3. You will then be redirected to the View Service Account screen where you can
   1. Retrieve your Client Id
   2. View & Retrieve you Client Secret
   3. Regenerate you Client Secret in the event of a security concern
   4. View instructions on how to Create the accompanying API User

You can use your existing user for testing purposes but it is highly recommended that your production deployment has its own set of credentials. When giving your user a role, it is recommended to make them either an Account admin or an Organization Admin. They may NOT have more than one role.Login to the Manager Portal as an Account Admin and go to USERS!

1. Navigate to the users tab
   
2. Create a user.
3. Enter a first and last name.
4. Enter an Email Address.
5. Add either Account Admin or Organization Admin as the role.
6. Save.

1. Sort by Last Modified Date.
2. Click the envelope icon to send an invitation to register.
   

1. Check your email, you should have an invitation from Everbridge with a link to create your username and password. Click on the link in the email.
   
2. Create your username
3. Create your password.
4. Click Continue.
   

There are multiple ways to enable API access for your users:

• Log in to the Everbridge Manager Portal and select Users from the top menu bar.
• Edit the user by clicking on the pencil icon next to their name.
• Slide the API Access button to the right.