v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Notifications

Gets all registered notification channels

Gets a list of all registered notification channels.

get/notifications/v3/registrations

Query parameters

pageTokenstring

A token from the previously returned response to retrieve the specified page.

countinteger

The number of items to return per page.

projectIdstring

Project ID. Any HERE Tracking user must be a member of a Tracking project. The project ID can be implicitly resolved if the user calling the API is a member of a single project. If the user is a member of multiple projects, the projectId query parameter needs to be specified explicitly.

channelTypestring[]

Filter result by channelType.

Example: channelType[]=webhook, channelType[]=browserPull,email

userIdstring

The HERE Account ID of a user.

User ID. Can be used by the project admin to filter email and browser pull notification channels by subscriber.

emailBounceboolean

Filters by emailBounce property. When set to true, returns the email channels which are not active anymore due to email bounce. When set to false, returns all the channels which are active (and not only email channels).

Response

Success

The list of registered notification channels was returned

countinteger

The number of items in the response.

pageTokenstring

A token that can be used to retrieve the next page of the response.

Example response

{
  "count": 3,
  "data": [
    {
      "channelId": "11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000",
      "channelType": "webhook",
      "url": "https://example.com/call/this/web/hook1"
    },
    {
      "channelId": "97870f23-36cb-440f-96ef-38992d0b4ctd",
      "channelType": "webhook",
      "eventSource": "battery",
      "eventType": "BELOW_RANGE",
      "initialState": "false",
      "ruleId": "a3f652bc-a456-7f12-cd11-123ah761yt41",
      "url": "https://example.com/call/this/web/hook2"
    },
    {
      "channelId": "b6b07cae-db4c-49c1-b353-93c8dfc09453",
      "channelType": "email",
      "emailBounce": "false",
      "ruleId": "e0abbb7c-3bd7-4428-a576-7a9f347a82f3",
      "userId": "HERE-f51801ff-61c9-45b7-8f04-ecc68b6a7959"
    }
  ],
  "pageToken": "1490376144514"
}