Notifications API | REST

Selected Version:
Download Open API File

List Webhook Subscriptions

https://qa.api.wealthcare.com/notifications/1.1/subscriptions/webhooks

Lists all webhook subscriptions for the authenticated user. The response includes a list of subscriptions and their details. This endpoint returns 404 Not Found when no webhook subscriptions are found.

Required Scopes: notifications_subscriptions_read

Request

Query parameters

Query parameters page anchor
  • administratorId string

    Filters the result set by the administratorId.

    Min Length: 3
    Max Length: 10
  • pageSize integer

    The number of items returned per page. The maximum page size is 100.

  • pageToken string

    The token for the next page of results.

Response

Response body

Response body page anchor
  • data array <object>
    • subscriptionId string <uuid>

      The unique identifier for the subscription.

    • name string

      The name of the subscription.

      Min Length: 5
      Max Length: 50
    • administratorId string

      The TPA Id or owner of the events to be sent to the webhook.

      Min Length: 3
      Max Length: 10
    • events object
      • source string

        The namespace for the event.

        Min Length: 5
        Max Length: 50
      • type string

        The type of event that triggers the webhook.

        Min Length: 5
        Max Length: 50
    • active boolean

      Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

    • config object
      • url string

        The URL to which the payload will be delivered.

        Max Length: 4000
      • secretLastUpdateDate string <date-time>

        The date the secret was last updated.

    • status enum<string>

      The status of the subscription.

      Possible values: Ready SetupInProgress
    • updateDate string <date-time>

      The date the subscription was last updated.

    • createdDate string <date-time>

      The date the subscription was created.

  • paging object
    • nextToken string

      The next token to fetch the next page.

Response Headers 
No response yet.
Response Body 
No response yet.
Request
Response 
{
  "data": [
    {
      "subscriptionId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "My Webhook Subscription",
      "administratorId": "T00123",
      "events": {
        "source": "com.alegeus.events.wca",
        "type": "CardTransaction"
      },
      "active": true,
      "config": {
        "url": "https://example.com/webhook",
        "secretLastUpdateDate": "2023-10-01T12:00:00Z"
      },
      "status": "Ready",
      "updateDate": "2023-10-01T12:00:00Z",
      "createdDate": "2023-10-01T12:00:00Z"
    }
  ],
  "paging": {
    "nextToken": "abc123"
  }
}

Copyright © 2026 Alegeus Technologies, LLC. All rights reserved. Alegeus, Alegeus Technologies, WealthCare, WealthCare Saver are registered trademarks of Alegeus Technologies, LLC

AI Assistant Preview

Generating response...