> ## Documentation Index
> Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List informational webhooks

> Retrieve the informational webhook configured in your Portal Admin Dashboard.




## OpenAPI

````yaml /openapi/custodian-api.yaml get /custodians/me/alerts/webhooks
openapi: 3.1.0
info:
  title: Portal Custodian API
  version: '3.0'
  description: >
    The Portal Custodian API provides endpoints for managing clients, building
    transactions,

    retrieving wallet data, managing delegations, informational webhooks and gas
    sponsorship, and

    reading the Portal Dashboard audit log.

    All endpoints require authentication via a Portal API Key (also known as a
    Custodian API Key)

    passed as a Bearer token.


    ## Base URL

    `https://api.portalhq.io/api/v3`


    ## Authentication

    Include your Portal API Key as a Bearer token in the `Authorization` header
    of every request.


    ## Chain ID Format

    Chain parameters use either friendly names (e.g. `ethereum`, `solana`) or
    CAIP-2 format

    (e.g. `eip155:1`, `solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp`). When using
    CAIP-2 format

    in URLs, ensure the colon is URI-encoded (`%3A`).
servers:
  - url: https://api.portalhq.io/api/v3
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Clients
    description: Create and manage Portal clients
  - name: Transactions
    description: Build and evaluate blockchain transactions
  - name: Wallet Metadata
    description: Retrieve wallet balances and NFTs
  - name: Wallet Shares
    description: Manage backup shares and wallet ejection
  - name: Delegations
    description: Manage token delegations and delegated transfers
  - name: Session Keys
    description: Build and send EIP-7702 session key user operations
  - name: Informational Webhooks
    description: >-
      Manage informational webhooks, external addresses, and resend failed
      events
  - name: Gas Sponsorship
    description: View and manage gas sponsorship across chains
  - name: Due
    description: Manage Due webhook endpoints and deliveries
  - name: Audit Events
    description: Read the audit log of actions taken in the Portal Dashboard
paths:
  /custodians/me/alerts/webhooks:
    get:
      tags:
        - Informational Webhooks
      summary: List informational webhooks
      description: >
        Retrieve the informational webhook configured in your Portal Admin
        Dashboard.
      operationId: listAlertWebhooks
      responses:
        '200':
          description: Informational webhooks retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertWebhookListResponse'
              example:
                data:
                  - autoAddNewAddresses: true
                    createdAt: '2024-12-19T19:05:04.707Z'
                    events:
                      - EIP_155_TX_V1
                    id: cm4voycw2001f68veade3tr0i
                    updatedAt: '2024-12-19T20:07:16.648Z'
                    url: https://example.com/alerts-webhooks/1/events
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - invalid or missing authentication token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AlertWebhookListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AlertWebhook'
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    AlertWebhook:
      type: object
      properties:
        autoAddNewAddresses:
          type: boolean
        createdAt:
          type: string
          format: date-time
        disabledAt:
          type: string
          format: date-time
          nullable: true
          description: When Portal turned off the webhook. `null` while it's on.
        disabledReason:
          type: string
          nullable: true
          description: >-
            Why Portal turned off the webhook, for example
            `TUNNEL_DOMAIN_DELIVERY_FAILURES`. `null` while it's on.
        events:
          type: array
          items:
            type: string
        id:
          type: string
        updatedAt:
          type: string
          format: date-time
        url:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Portal API Key (Custodian API Key). Pass as a Bearer token in the
        Authorization header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.