> ## 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 alert webhook events

> Retrieve a list of events sent to your alert webhook, including those that
failed to be delivered.




## OpenAPI

````yaml /openapi/custodian-api.yaml get /custodians/me/alerts/webhooks/{alertWebhookId}/events
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, alert webhooks, and gas
    sponsorship.

    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: Alert Webhooks
    description: Manage alert webhooks, external addresses, and replay failed events
  - name: Gas Sponsorship
    description: View and manage gas sponsorship across chains
paths:
  /custodians/me/alerts/webhooks/{alertWebhookId}/events:
    get:
      tags:
        - Alert Webhooks
      summary: List alert webhook events
      description: >
        Retrieve a list of events sent to your alert webhook, including those
        that

        failed to be delivered.
      operationId: listAlertWebhookEvents
      parameters:
        - $ref: '#/components/parameters/alertWebhookId'
        - name: eventTypes
          in: query
          required: false
          description: The alert webhook event types to filter by.
          schema:
            type: string
            enum:
              - EIP_155_TX_V1
        - name: deliveryStatuses
          in: query
          required: false
          description: Filter by delivery status.
          schema:
            type: string
            enum:
              - success
              - failed
              - pending
        - name: since
          in: query
          required: false
          description: Returns only events that occurred after this Unix timestamp.
          schema:
            type: number
        - name: until
          in: query
          required: false
          description: Returns only events that occurred before this Unix timestamp.
          schema:
            type: number
        - name: cursor
          in: query
          required: false
          description: The alert webhook event ID for cursor-based pagination.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          description: The number of events to retrieve. Default is 100.
          schema:
            type: integer
            default: 100
        - name: transactionHash
          in: query
          required: false
          description: Filter by transaction hash.
          schema:
            type: string
        - name: blockNumbers
          in: query
          required: false
          description: Filter by block numbers (comma-delimited).
          schema:
            type: string
        - name: chainIds
          in: query
          required: false
          description: Filter by CAIP-2 chain IDs (comma-delimited).
          schema:
            type: string
      responses:
        '200':
          description: Alert webhook events retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertWebhookEventsResponse'
              example:
                data:
                  - blockNumber: 7313326
                    chainId: eip155:11155111
                    confirmed: 1
                    createdAt: '2024-12-19T20:08:17.086Z'
                    deliveryStatus: success
                    errorMessage: null
                    id: 85f3d2f7-b2ff-417d-b9cb-dc9823b4ae61
                    retries: 0
                    transactionHashes:
                      - >-
                        0x4978a4ba15a018532791ba4491e48b1aa8b544309c1ffce062bb1fb7e84dc069
                    type: EIP_155_TX_V1
                    updatedAt: '2024-12-19T20:08:17.086Z'
                metadata:
                  alertWebhook:
                    id: alertWebhookId1
                    url: https://example.com/alerts/webhooks/1/events
                  cursor: null
                  limit: 100
                  total: 4
        '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:
  parameters:
    alertWebhookId:
      name: alertWebhookId
      in: path
      required: true
      description: The unique identifier of the alert webhook.
      schema:
        type: string
  schemas:
    AlertWebhookEventsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AlertWebhookEvent'
        metadata:
          type: object
          properties:
            alertWebhook:
              type: object
              properties:
                id:
                  type: string
                url:
                  type: string
            cursor:
              type: string
              nullable: true
            limit:
              type: integer
            total:
              type: integer
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message describing what went wrong
    AlertWebhookEvent:
      type: object
      properties:
        blockNumber:
          type: integer
        chainId:
          type: string
        confirmed:
          type: integer
          nullable: true
        createdAt:
          type: string
          format: date-time
        deliveryStatus:
          type: string
          enum:
            - success
            - failed
            - pending
        errorMessage:
          type: string
          nullable: true
        id:
          type: string
        retries:
          type: integer
        transactionHashes:
          type: array
          items:
            type: string
        type:
          type: string
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: |
        Portal API Key (Custodian API Key). Pass as a Bearer token in the
        Authorization header.

````