v1

latestOpenAPI 3.0.32026-07-24434977.4 KB

LPR Hotlist Alert Subscriptions

Create Subscription

Create a new LPR hotlist alert webhook subscription

post/integrations/lpr/alerts/subscriptions

Request body

namestring

optional name to describe the webhook subscription

callbackUrlstring url required

endpoint that webhooks should be submitted to

contentType'application/json' | 'application/xml' required

content type that webhooks should be provided as

customHotlistAudienceFilter'any' | 'organization'

Optionally include LPR hotlist alerts from custom hotlists with restricted audiences

any - Custom hotlists with organization-wide audience and restricted audience e.g. role-based or user-based audiences
organization - Custom hotlists with organization-wide audience only

enabledFirstResponderJurisdictionAlertsboolean

indicates whether the subscription should accept hotlist alerts from shared networks in the organization's First Responder Jurisdiction or not

enabledboolean

indicates whether the subscription should be enabled or not

Example request

{
  "callbackUrl": "https://example.com/your/webhook",
  "credentials": {
    "apiKey": {
      "headerName": "x-api-key"
    },
    "basic": {
      "headerName": "Authorization"
    },
    "oauth2": {
      "tokenEndpoint": "https://example.auth0.com/oauth/token",
      "grantType": "client_credentials",
      "headerName": "Authorization"
    }
  }
}

Response

Subscription Created

namestring

optional name to describe the webhook subscription

callbackUrlstring url required

endpoint that webhooks should be submitted to

contentType'application/json' | 'application/xml' required

content type that webhooks should be provided as

customHotlistAudienceFilter'any' | 'organization'

Optionally include LPR hotlist alerts from custom hotlists with restricted audiences

any - Custom hotlists with organization-wide audience and restricted audience e.g. role-based or user-based audiences
organization - Custom hotlists with organization-wide audience only

enabledFirstResponderJurisdictionAlertsboolean

indicates whether the subscription should accept hotlist alerts from shared networks in the organization's First Responder Jurisdiction or not

enabledboolean

indicates whether the subscription should be enabled or not

idstring uuid required

id of the webhook subscription

createdAtstring date-time

RFC3339 UTC timestamp of when the webhook subscription was created

updatedAtstring date-time

RFC3339 UTC timestamp of when the webhook subscription was most recently updated

Example response

{
  "callbackUrl": "https://example.com/your/webhook",
  "credentials": {
    "apiKey": {
      "headerName": "x-api-key"
    },
    "basic": {
      "headerName": "Authorization"
    },
    "oauth2": {
      "tokenEndpoint": "https://example.auth0.com/oauth/token",
      "grantType": "client_credentials",
      "headerName": "Authorization"
    }
  }
}