Getting Started Guide

Introduction

Welcome to the Everbridge Suite API Getting Started Guide. In this guide you will learn how to:

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.

Everbridge currently only supports 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

Create a Service Account

Service Account Client Credentials can be created and managed by the Account and the Organization level 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.

Service Account creation

  1. In the Everbrige Manager Portal, navigate to either

    • UsersService Accountsfrom the Account level
    • SettingsAccountService 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

Creating API user

Create a User in Manager Portal

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.

Invite User to Sign-up

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

Register a User Account

  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.

Enable API Access for Your User

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

1. Using Manager Portal (Account level)

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

2. Using API

POST /users
{
   "apiAccess":true
}

3. User Upload

When users are uploaded, API access can also be enabled or disabled in the CSV file under the API Access header:

Making API Calls

1. Get Your Organization ID

If you are logged in as an account admin, select an organization from the top right of the page.

  1. Make sure the desired organization is selected.
  2. Hover over Settings.
  3. Click Organization in the drop down.
  4. Click the Organization drop down to the left of the page.
  5. Click Base Information.
  6. Copy your Organization ID.

2. Authenticate

  1. OAuth 2.0
  2. Basic
  3. Access Token

3. Make an API Call Using this Developer Portal

  1. Click on API Reference on the navigation bar
  2. Enter your Authentication options
  3. Pick up an existing sample from the request section
  4. Update organizationId and other parameters from the request path and body

4. Make an API Call Using Swagger

Go to the Swagger interface of the Everbridge API: https://api.everbridge.net/.

For this example, we will look at the /contacts API to show you how to retrieve contact information.

  1. Select the /contacts grouping.
  2. Enter your encoded credentials.
  3. Enter your Organization ID.
  4. Click Execute.

A successful API call will return code 200 and will show "OK" in the response body.

5. Export the OpenAPI spec

This option would be to execute your API requests from another application such as Postman.

  • Simply select the OAS file you wish to download from the list hosed here.
  • Copy the JSON data and save it in your application's preferred format

Common Questions

1. Will my API password expire?

This depends on how the security configurations are set up for your account. Please reach out to your account manager to confirm.

2. Can my user have more than one role?

Generally speaking, it is NOT recommended. There is a specific workaround if this is absolutely needed. See the documentation on users and roles for details on how this feature works.

3. What are API best practices?

  1. Create a unique user for each of your integrations.
  2. Never user your API user to log into the Manager Portal.
  3. Use a good naming convention for your API user:
    1. First Name: DO_NOT_DELETE
    2. Last Name: APIUSER[INTEGRATION_NAME]
    3. Username: APIUSER[INTEGRATION_NAME]
    4. Email: A group email that is associated with the integration