Everbridge Template 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 Template 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
10 operations
across 6 paths,
and defines 63 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.
The identity and technical contract details declared by the specification.
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
AudioBulletinBoardPublicMessage
object
The ABB public message content.
5 properties
3 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
ContactRecipientId
object
Refers to a contact recipient by its contact ID.
2 properties
2 required
TextOnlyPathCategory
string
A group of contact path types that only support textual messaging.
ApiDeliveryPathPrompt
object
The unique description, provided by the organization, for the delivery path.
2 properties
2 required
TemplateDetail
object
31 properties
GroupRecipientId
object
Refers to a group of contact recipients by a group ID.
2 properties
2 required
Facebook
object
The Facebook custom message content.
3 properties
PublicMessagePermission
object
7 properties
LaunchMessageBody
object
2 properties
2 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
MemberPortalPublicMessage
object
The member portal public message content.
2 properties
2 required
ContentAttachment
object
5 properties
Command
object
1 property
1 required
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
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
SmsSettings
object
The SMS short code or phone number shown to recipients of text messages.
2 properties
2 required
ApiPaginatedResponse
object
A page of data from an endpoint.
2 properties
DeliverySettings
object
Settings that adjust the way that notifications are delivered to recipients.
8 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
ContactRecipientExternalId
object
Refers to a contact recipient by its contact external ID.
2 properties
2 required
TemplateLookupRequest
object
3 properties
1 required
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
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
CemResultsLastKnownLocationType
object
Specifies how to include contacts with "Last Known" location types in CEM Results.
2 properties
1 required
TemplatePermission
object
4 properties
CemResultsStringPropertyQuery
WebWidgetPublicMessage
object
The web widget public message content.
5 properties
3 required
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
CemResultsNumberPropertyQuery
ApiDeliveryPathPathId
object
A unique identifier for the delivery path.
2 properties
2 required
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
CommsResponse
object
1 property
1 required
SocialMediaPublicMessage
object
The social media public message content.
5 properties
2 required
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
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
GenericOneWayPublicMessage
object
The GenericOneWay public message content.
3 properties
3 required
TemplateBase
object
24 properties
1 required
CemResultsTravelLocationType
object
Specifies how to include contacts with travel location types in CEM Results.
5 properties
1 required
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
TemplateConvertRequest
object
1 property
1 required
TemplateCreateRequest
object
14 properties
1 required
TemplateUpdateRequest
object
Partial update request for a template. Omit a field to leave it unchanged. Set a nullable field to null to clear its value when the field supports clearing. Pr…
14 properties
CemResultsCompleteName
object
Used to describe a contact's complete name in a CEM Results query.
5 properties
3 required
Geometry
object
A geojson representation of a map shape.
AlertUsPublicMessage
object
The AlertUs public message content.
4 properties
2 required
AudioOnlyPathCategory
string
A group of contact path types that only support audio messaging.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Everbridge publishes across the network.
