Skip to content

Elevate Tripwire API (1.2)

Tripwire Management

Currently provides read-only access to Tripwire-related entities like alerts and notifications to allow API users to automate processes linked to Tripwire usage monitoring and alerting

Definitions

  • Tripwire alert - returns the date and time of alerts, the type of the alerts, and any additional details that may be useful in assessing the severity of the alerts
  • Tripwire notification - returns the activity that was performed when an alert was triggered, whether that's sending an email, SMS, or custom action Tripwire plan - a named tripwire plan of tripwire rules used to identify alerts and notifications
Download OpenAPI description
billing-rest-tripwire.json
billing-rest-tripwire.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

tripwire-alerts

returns the date and time of alerts, the type of alert, threshold value and other details to allow analysis of the alert

Operations

tripwire-notifications

the notifications that are (optionally) performed when alerts are triggered

Operations

Get a list of Tripwire notifications

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fieldsstring(FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
createdstring(StringFilterParam)required

Filter by the notification created date and time

Example: created=gt:2022-01-01T00:00:00Z
eventStartDatestring(StringFilterParam)

Filter by the date and time an event started

Example: eventStartDate=gt:2022-01-01T00:00:00Z
eventEndDatestring(StringFilterParam)

Filter by a single date and time an event ended

Example: eventEndDate=lt:2022-01-01T00:00:00Z
actionstring

Filter notifications by action taken

Example: action=EMAIL_CUSTOMER_CONTACTS
productReferencestring(StringFilterParam)

Filter notifications by the product reference of the associated usage product inventory

Example: productReference=xyz | in:x,y | like:xyz
usageProductInventoryIdstring(StringFilterParam)

Filter notifications by usage product inventory id

Example: usageProductInventoryId=xyz | in:x,y | like:xyz
customerIdstring(StringFilterParam)

Filter notifications by customer identifier

Example: customerId=xyz | in:x,y | like:xyz
siteIdstring(StringFilterParam)

Filter notifications by site identifier

Example: siteId=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/tripwire-notifications?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&created=gt%3A2022-01-01T00%3A00%3A00Z&eventStartDate=gt%3A2022-01-01T00%3A00%3A00Z&eventEndDate=lt%3A2022-01-01T00%3A00%3A00Z&action=EMAIL_CUSTOMER_CONTACTS&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&usageProductInventoryId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&customerId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)

Notification activity identifier

Example: 1
createdstring(date-time)
Example: "2022-01-01T00:00:00Z"
whenActionAppliedstring(date-time)
Example: "2022-01-01T00:00:00Z"
planIdnumber

Tripwire plan identifier

planRuleNamestring

Tripwire plan rule description

Example: "Daily calls exceeding £10.00"
eventStartDatestring(date-time)
Example: "2022-01-01T00:00:00Z"
eventEndDatestring(date-time)
Example: "2022-01-01T00:00:00Z"
actionstring(NotificationType)

Tripwire notification activity to be performed when a Tripwire alert is triggered, i.e. send an email to the client/affected customer, suspend the number, or other custom actions (available by contacting the Elevate support team)

Enum"EMAIL_BILLING_CLIENT""SMS_BILLING_CLIENT""EMAIL_CUSTOMER_CONTACTS""SMS_CUSTOMER_CONTACTS""TEMPORARY_OUT_OF_SERVICE""OUTBOUND_CALLS_BARRED""CUSTOM_BC_ACTION""USAGE_CAP_TRIGGER_ACTION""NO_BC_ACTION"
totalPricenumber

Total price in major currency (e.g. pounds/dollars/euros)

Example: 10
totalCallCountinteger(int32)

Total call count value

Example: 15
usageProductInventoryIdinteger(int32)

Usage product inventory identifier

Example: 10
productReferencestring

Product reference

customerIdnumber

Customer identifier

Example: 1234
siteIdnumber

Site identifier

Example: 1234
]
Response
application/json
[
  {
    "id": 1,
    "created": "2022-01-01T00:00:00Z",
    "whenActionApplied": "2022-01-01T00:00:00Z",
    "planId": 0,
    "planRuleName": "Daily calls exceeding £10.00",
    "eventStartDate": "2022-01-01T00:00:00Z",
    "eventEndDate": "2022-01-01T00:00:00Z",
    "action": "EMAIL_BILLING_CLIENT",
    "totalPrice": 10,
    "totalCallCount": 15,
    "usageProductInventoryId": 10,
    "productReference": "string",
    "customerId": 1234,
    "siteId": 1234
  }
]

tripwire-plans

the tripwire plans that are used to generate the alerts

Operations

tripwire-alert-activities

the tripwire alert activities

Operations