Everbridge Comms APIs API
The Comms APIs API from Everbridge — 36 operation(s) for comms apis.
Everbridge Comms APIs API is one of 91 APIs that Everbridge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Comms APIs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.
This API exposes 42 operations across 36 paths, and defines 108 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://api.everbridge.net/managerapps/communications/v1.
42 operations
36 paths
108 schemas
26 GET6 PATCH10 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Everbridge Comms APIs API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (API_Authorizer).
An API key is passed in the header as x-api-key (api_key).
Paths & Operations 42
Across 36 paths, the API surfaces 42 operations — 26 GET, 6 PATCH, 10 POST. Each is listed below with its method, path, parameters, and response codes.
Comms APIs 42
POST
/deprecated
Launch Communication
GET
/deprecated
List Communications
PATCH
/{commId}deprecated
Update communication description, title, eventType and active
GET
/{commId}deprecated
Get Communication
POST
/resenddeprecated
Resend Communication
PATCH
/{commId}/stopdeprecated
Stop Communication
PATCH
/{commId}/publish-optionsdeprecated
Deactivate or expire a single communication publish option message
GET
/{commId}/publish-optionsdeprecated
Retrieve a single communication publish option path detail
POST
/{commId}/confirmation-resultdeprecated
Generate a resultset based on communication confirmations
POST
/{commId}/operator-confirmationdeprecated
Confirm operators for a communication
POST
/comm
Launch Communication
GET
/comm
List Communications
PATCH
/comm/{commId}
Update communication description, title, eventType and active
GET
/comm/{commId}
Get Communication
POST
/comm/resend
Resend Communication
PATCH
/comm/{commId}/stop
Stop Communication
PATCH
/comm/{commId}/publish-options
Deactivate or expire a single communication publish option message
GET
/comm/{commId}/publish-options
Retrieve a single communication publish option path detail
POST
/comm/{commId}/confirmation-result
Generate a resultset based on communication confirmations
POST
/comm/{commId}/operator-confirmation
Confirm operators for a communication
GET
/{commId}/geometrydeprecated
Get communication geometry
GET
/{commId}/settingsdeprecated
Get Communication Settings
GET
/{commId}/contextdeprecated
Get Communication Context Data
GET
/{commId}/content/{contentId}deprecated
Get Communication Body
GET
/{commId}/recipientsdeprecated
Get Communication CEM Results
GET
/{commId}/recipient-logsdeprecated
List Communication recipient logs
POST
/{commId}/recipient-logs/downloaddeprecated
Create Communication recipient log download
GET
/{commId}/summary/{summaryType}deprecated
Get Communication Summary by Summary Type
GET
/{commId}/activitiesdeprecated
List Communication Activities
GET
/{commId}/activity-entrydeprecated
Retrieve a single communication activity entry
GET
/{commId}/thread-recipientsdeprecated
Retrieve a thread's CEM Results
GET
/comm/{commId}/geometry
Get communication geometry
GET
/comm/{commId}/settings
Get Communication Settings
GET
/comm/{commId}/context
Get Communication Context Data
GET
/comm/{commId}/content/{contentId}
Get Communication Body
GET
/comm/{commId}/recipients
Get Communication CEM Results
GET
/comm/{commId}/recipient-logs
List Communication recipient logs
POST
/comm/{commId}/recipient-logs/download
Create Communication recipient log download
GET
/comm/{commId}/summary/{summaryType}
Get Communication Summary by Summary Type
GET
/comm/{commId}/activities
List Communication Activities
GET
/comm/{commId}/activity-entry
Retrieve a single communication activity entry
GET
/comm/{commId}/thread-recipients
Retrieve a thread's CEM Results
Schemas 108
The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are CommDetail (29 properties), SemanticQuery (18 properties), CommData (17 properties), CommRecipientLog (16 properties). Each schema is shown below with its type and property counts.
ContentMetadata
object
5 properties
AudioBulletinBoardPublicMessage
object
The ABB public message content.
5 properties
3 required
ActivityEntry
object
7 properties
CommRecipientLogPerPath
object
7 properties
Facebook
object
The Facebook custom message content.
3 properties
LaunchMessageBody
object
2 properties
2 required
PathCategory
string
recipientStatisticSummary
object
Recipient statistics summary associated with the communication. - STILL IN DEVELOPMENT
8 properties
PublishOptionPathResponse
object
The publish option path detail info you requested.
11 properties
StopCommsResponse
object
1 property
1 required
CommRecipientSource
object
2 properties
DeliverySettings
object
Settings that adjust the way that notifications are delivered to recipients.
8 properties
ContactRecipientExternalId
object
Refers to a contact recipient by its contact external ID.
2 properties
2 required
CommData
object
17 properties
PreviewCommResponse
object
The rendered communication content for preview.
1 property
SupportedLanguages
string
A combined language and region tag that signifies the default language to use when selecting a message body to send to a recipient. Note: Currently, all commun…
VoiceSettings
object
The caller ID number displayed when contacting recipients via phone.
3 properties
3 required
ApiDeliveryPathPathId
object
A unique identifier for the delivery path.
2 properties
2 required
ConfirmationSummary
object
A list of summaries associated with the communication. - STILL IN DEVELOPMENT
6 properties
ContactRecipientName
object
Refers to a contact recipient by their name as shown in the [Everbridge Contacts API](https://developers.everbridge.net/internal/reference/ebs-list-contacts).
5 properties
3 required
SocialMediaPublicMessage
object
The social media public message content.
5 properties
2 required
MessageBody
object
This is the base object that AudioBody, TextualBody, and WebpageBody is build upon.
5 properties
5 required
GenericOneWayPublicMessage
object
The GenericOneWay public message content.
3 properties
3 required
PublicCommError
object
3 properties
CemResultsCompleteName
object
Used to describe a contact's complete name in a CEM Results query.
5 properties
3 required
CommContentMetadata
object
3 properties
EverbridgeCommunityPublicMessage
object
The Everbridge Community publish toggle. This message carries no body fields and is used only to signal routing/selection in the launch request.
MemberPortalBody
object
The member portal public message content.
2 properties
2 required
ActivityPaginatedResponse
MessageContent
object
Notification message content that is included within the communication. If a templateId is present, this value becomes optional and will override the template'…
3 properties
1 required
CommPaginatedResponse
DeactivatePublishOptionVO
object
2 properties
2 required
Tag
string
A value used to contain a simple categorization.
activity
object
2 properties
PreviewCommRequest
Request body for previewing a communication. Only valid when mode is PREVIEW.
PreviewMode
string
Render the template and its fields for preview but does not launch the communication nor send any notifications.
LaunchCommRequest
Request body for launching a communication. Only valid when mode is LIVE or SIMULATION.
BaseLaunchCommRequest
object
5 properties
LaunchMode
string
Adjust the behavior of the communication: LIVE: Launch the communication and send notifications to all recipients. At least one recipient must be specified in…
GenericOneWayBody
object
The GenericOneWay public message content.
3 properties
3 required
ContentAttachment
object
5 properties
Command
object
1 property
1 required
SenderSettings
object
Specify what recipients will see as the "sender" of the notifications sent from the communication (e.g. caller ID upon receiving a phone call.)
3 properties
AudioBulletinBoardBody
object
The ABB public message content.
5 properties
3 required
AudioBody
When the delivery is of an audio format, the caller should expect the properties of this object to be present.
1 required
CemResultsLastKnownLocationType
object
Specifies how to include contacts with "Last Known" location types in CEM Results.
2 properties
1 required
ProblemDetail
object
An RFC-7807 compliant model for error details.
5 properties
CemResultsNumberPropertyQuery
CapContent
object
Shared CAP transport metadata for a public-safety delivery instance. The public-comms webpage shortUrl is not part of this content; it is system-generated and…
6 properties
6 required
CemResultsExpectedLocationType
object
Specifies how to include contacts with expected location types in CEM Results.
1 property
1 required
NetworkBody
object
The Network public message content.
4 properties
4 required
RecipientLogDownloadResponse
object
3 properties
TextOnlyPathCategory
string
A group of contact path types that only support textual messaging.
PatchCommRequest
object
4 properties
AlertUsBody
object
The AlertUs public message content.
4 properties
2 required
ApiDeliveryPathPrompt
object
The unique description, provided by the organization, for the delivery path.
2 properties
2 required
GroupRecipientId
object
Refers to a group of contact recipients by a group ID.
2 properties
2 required
ResendCommRequest
object
3 properties
1 required
OperatorConfirmationRequest
object
2 properties
1 required
SemanticQuery
object
A query use for generating a CEM Result built with semantic logic
18 properties
ApiDeliveryPath
Delivery paths are ordered methods of contacting recipients, such as "work email" or "home phone".
NetworkPublicMessage
object
The Network public message content.
4 properties
4 required
CemResultsStaticLocationType
object
Specifies how to include contacts with static location types in CEM Results.
3 properties
1 required
UserReference
object
The person who launched the communication and thus created the activity.
5 properties
MemberPortalPublicMessage
object
The member portal public message content.
2 properties
2 required
RoleItem
object
2 properties
TextualBody
When the delivery is of a non graphical text format, the caller should expect the properties of this object to be present.
Role
object
2 properties
LaunchRecipients
object
Describes the recipients of notifications from the communication. At least one recipient must be provided when Mode is LIVE or SIMULATION. Note: When specifyin…
7 properties
Twitter
object
The Twitter custom message content.
4 properties
OperatorConfirmationResponse
object
2 properties
1 required
ThreadRecipientsResponse
array
CommRecipientAddress
object
5 properties
TextualMessageBody
RuleRecipientName
object
Refers to a contact rule (filter) by its name. Retrieve contact rule names using the [Everbridge Contact Filters API](https://developers.everbridge.net/interna…
2 properties
2 required
WebWidgetBody
object
The web widget public message content.
5 properties
3 required
AlertUsPublicMessage
object
The AlertUs public message content.
4 properties
2 required
PublishOptionMessageDeactivatedResponse
object
5 properties
questionnaire
object
A list of answers to a provided question for recipients to respond with during confirmation. Note that this property is mutually exclusive with conferenceBridg…
2 properties
1 required
AlertUsSetting
object
The rest alert us setting content
4 properties
2 required
ApiSettings
object
Settings that adjust how the communication is sent to the recipients.
5 properties
ContextData
object
2 properties
ContactRecipientId
object
Refers to a contact recipient by its contact ID.
2 properties
2 required
CommRecipientLog
object
16 properties
WebPageMessageBody
RenderedTextContent
A rendered text content object.
MessageDetailBody
object
This is the base object that AudioBody, TextualBody, WebpageBody and all kinds of public message body is build upon.
2 properties
WebPageBody
When the delivery is of a HTML format, the caller should expect the properties of this object to be present.
SocialMediaBody
object
The social media public message content.
5 properties
2 required
AbstractApiPaginatedResponse
object
A page of data from an endpoint.
2 properties
AudioMessageBody
RuleRecipientId
object
Refers to a group of contact rules (filters) by an ID. Retrieve contact rule IDs using the [Everbridge Contact Filters API](https://developers.everbridge.net/i…
2 properties
2 required
SmsSettings
object
The SMS short code or phone number shown to recipients of text messages.
2 properties
2 required
CommDetail
object
29 properties
ResultSetQueryRecipients
object
An ID of an existing CEM Results result set where the contacts cached within the result set are included as recipients in the communication.
2 properties
2 required
RecipientSettings
object
Settings that adjust how recipients respond to the communication.
4 properties
CemResultsBooleanPropertyQuery
GroupRecipientName
object
Refers to a group of contact recipients by a name as shown in the [Everbridge Groups API](https://developers.everbridge.net/internal/reference/ebs-list-groups).
2 properties
2 required
CemResultsPropertyQuery
object
1 property
1 required
CemResultsStringPropertyQuery
WebWidgetPublicMessage
object
The web widget public message content.
5 properties
3 required
RenderedContent
CommsResponse
object
1 property
1 required
CAPPublicMessage
object
A CAP public-message body targeted at one or more CAP modalities (paths). Shared CAP transport metadata is carried under cap. Multiple CAP public messages are…
3 properties
2 required
CemResultsTravelLocationType
object
Specifies how to include contacts with travel location types in CEM Results.
5 properties
1 required
ConfirmationByPathSummary
object
Confirmation by path summary associated with the communication.
6 properties
Geometry
object
A geojson representation of a map shape.
AudioOnlyPathCategory
string
A group of contact path types that only support audio messaging.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Everbridge 12
Other APIs Everbridge publishes across the network.
Everbridge iPaaS API
Everbridge Asset Association Definition API
Everbridge Asset License Limit Stats API
Everbridge Asset Type Templates API
Everbridge Asset Types API
Everbridge Asset Upload Batches API
Everbridge Assets API
Everbridge Assets Batch API
Everbridge Assets Query API
Everbridge Attachments API
Everbridge Audio API
Everbridge Audit Log API
#Comms APIs
Where this information came from
This is an independent, third-party profile of Everbridge Comms APIs API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.