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

# List webhooks

> Lists webhooks for an app.



## OpenAPI

````yaml /api-reference/notifications_webhooks_v1.json get /v1/notifications/webhooks
openapi: 3.0.3
info:
  title: Webhooks Management
  description: >-
    The PayPal REST APIs use <a
    href="/docs/api/notifications/webhooks/"/>webhooks</a> for event
    notification. Webhooks are HTTP callbacks that receive notification messages
    for events. After you configure a webhook listener for your app, you can <a
    href="#webhooks_create">create a webhook</a>, which subscribes the webhook
    listener for your app to events. The <code>notifications</code> namespace
    contains resource collections for webhooks.
  version: '1.11'
  contact: {}
servers:
  - url: https://api-m.sandbox.paypal.com
    description: PayPal Sandbox Environment
  - url: https://api-m.paypal.com
    description: PayPal Live Environment
security: []
tags:
  - name: webhooks
    description: >-
      Use the `/webhooks` resource to subscribe your webhook listener to events,
      list webhooks for an app, show details for, update, delete, and list event
      subscriptions for webhooks.
  - name: webhooks-lookup
    description: >-
      Use the `/webhooks-lookup` resource to create, list, show details for, and
      delete webhook lookups.
  - name: verify-webhook-signature
    description: >-
      Use the `/verify-webhook-signature` resource to verify a webhook
      signature.
  - name: webhooks-event-types
    description: >-
      Use the `/webhooks-event-types` resource to list available events to which
      any webhook can subscribe.
  - name: webhooks-events
    description: >-
      Use the `/webhooks-events` resource to list, show details for, and resend
      event notifications.
  - name: simulate-event
    description: >-
      Use the `/simulate-event` resource to use a sample payload to simulate a
      webhook event. The events that this call generates only serve to validate
      the connection to the listener URL and to show how webhook events look.
      <blockquote><strong>Note:</strong> You can also use the <a
      href="/docs/api/notifications/webhooks/simulator/">Webhooks simulator</a>
      to simulate webhook events.</blockquote>
  - name: publish-event-with-payload
    description: >-
      Use the `/publish-event-with-payload` resource to publish an event with a
      specified payload.
  - name: publish-event-with-reference
    description: >-
      Use the `/publish-event-with-reference` resource to publish an event with
      a specified reference.
  - name: webhook-event-delivery-status
    description: >-
      Use the `/webhook-event-delivery-status` resource to show the webhook
      event send status.
  - name: webhooks-error-types
    description: >-
      Use the `/error-types` resource to create and list available webhook error
      types.
  - name: webhooks-errors
    description: >-
      Use the `/webhooks-errors` resource to create, list, show details for, and
      update webhook errors.
  - name: batch-resend
    description: Use the `/batch-resend` resource to send out IPN/Webhooks in batches.
externalDocs:
  url: https://developer.paypal.com/docs/api/webhooks/v1/
paths:
  /v1/notifications/webhooks:
    get:
      tags:
        - webhooks
      summary: List webhooks
      description: Lists webhooks for an app.
      operationId: webhooks.list
      parameters:
        - $ref: '#/components/parameters/anchor_type'
      responses:
        '200':
          description: >-
            A successful request returns the HTTP `200 OK` status code and a
            JSON response body that lists webhooks with webhook details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookList'
        default:
          description: The error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error-2'
      security:
        - Oauth2:
            - https://uri.paypal.com/services/applications/webhooks
components:
  parameters:
    anchor_type:
      name: anchor_type
      in: query
      description: Filters the webhooks in the response by an `anchor_id` entity type.
      schema:
        type: string
        enum:
          - APPLICATION
          - ACCOUNT
        default: APPLICATION
  schemas:
    WebhookList:
      type: object
      title: Webhook List
      description: A list of webhooks.
      properties:
        webhooks:
          $ref: '#/components/schemas/webhook_list'
    error-2:
      type: object
      title: Error
      description: The error details.
      properties:
        name:
          type: string
          description: The human-readable, unique name of the error.
        message:
          type: string
          description: The message that describes the error.
        debug_id:
          type: string
          description: The PayPal internal ID. Used for correlation purposes.
        information_link:
          type: string
          description: >-
            The information link, or URI, that shows detailed information about
            this error for the developer.
          readOnly: true
        details:
          $ref: '#/components/schemas/error_details_list'
        links:
          $ref: '#/components/schemas/link_description_list'
      required:
        - name
        - message
        - debug_id
    webhook_list:
      type: array
      description: An array of webhooks.
      items:
        $ref: '#/components/schemas/webhook'
    error_details_list:
      type: array
      description: An array of additional details about the error.
      items:
        $ref: '#/components/schemas/error_details-2'
    link_description_list:
      type: array
      description: >-
        An array of request-related [HATEOAS
        links](/docs/api/reference/api-responses/#hateoas-links).
      readOnly: true
      items:
        $ref: '#/components/schemas/link_description'
    webhook:
      type: object
      title: Webhook
      description: One or more webhook objects.
      properties:
        id:
          type: string
          description: The ID of the webhook.
          readOnly: true
        url:
          type: string
          format: uri
          description: >-
            The URL that is configured to listen on `localhost` for incoming
            `POST` notification messages that contain event information.
          readOnly: false
          maxLength: 2048
        event_types:
          $ref: '#/components/schemas/definitions-event_type_list'
        links:
          $ref: '#/components/schemas/definitions-link_description_list'
      required:
        - url
        - event_types
    error_details-2:
      title: Error Details
      type: object
      description: The error details. Required for client-side `4XX` errors.
      properties:
        field:
          type: string
          description: >-
            The field that caused the error. If this field is in the body, set
            this value to the field's JSON pointer value. Required for
            client-side errors.
        value:
          type: string
          description: The value of the field that caused the error.
        location:
          type: string
          description: >-
            The location of the field that caused the error. Value is `body`,
            `path`, or `query`.
          default: body
        issue:
          type: string
          description: The unique, fine-grained application-level error code.
        description:
          type: string
          description: >-
            The human-readable description for an issue. The description can
            change over the lifetime of an API, so clients must not depend on
            this value.
      required:
        - issue
    link_description:
      type: object
      title: Link Description
      description: >-
        The request-related [HATEOAS
        link](/docs/api/reference/api-responses/#hateoas-links) information.
      required:
        - href
        - rel
      properties:
        href:
          type: string
          description: >-
            The complete target URL. To make the related call, combine the
            method with this [URI
            Template-formatted](https://tools.ietf.org/html/rfc6570) link. For
            pre-processing, include the `$`, `(`, and `)` characters. The `href`
            is the key HATEOAS component that links a completed call with a
            subsequent call.
        rel:
          type: string
          description: >-
            The [link relation
            type](https://tools.ietf.org/html/rfc5988#section-4), which serves
            as an ID for a link that unambiguously describes the semantics of
            the link. See [Link
            Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml).
        method:
          type: string
          description: The HTTP method required to make the related call.
          enum:
            - GET
            - POST
            - PUT
            - DELETE
            - HEAD
            - CONNECT
            - OPTIONS
            - PATCH
    definitions-event_type_list:
      type: array
      maxItems: 500
      description: >-
        An array of events to which to subscribe your webhook. To subscribe to
        all events, including events as they are added, specify the asterisk
        wild card. To replace the `event_types` array, specify the asterisk wild
        card. To list all supported events, <a href="#event-type_list">list
        available events</a>.
      readOnly: false
      items:
        $ref: '#/components/schemas/event_type'
    definitions-link_description_list:
      type: array
      description: >-
        An array of request-related [HATEOAS
        links](/docs/api/reference/api-responses/#hateoas-links/).
      readOnly: true
      items:
        $ref: '#/components/schemas/link_description'
    event_type:
      type: object
      title: Event Type
      description: An event type.
      properties:
        name:
          type: string
          description: >-
            The unique event name.<blockquote><strong>Note:</strong> To
            subscribe to all events, including events as they are added, specify
            an `*` as the value to represent a wildcard.</blockquote>
          readOnly: false
        description:
          type: string
          description: A human-readable description of the event.
          readOnly: true
        status:
          type: string
          description: The status of a webhook event.
          readOnly: true
        resource_versions:
          $ref: '#/components/schemas/resource_versions_list'
      required:
        - name
    resource_versions_list:
      type: array
      description: 'Identifier for the event type example: 1.0/2.0 etc.'
      readOnly: true
      items:
        $ref: '#/components/schemas/resource_versions'
    resource_versions:
      type: string
      description: The ID for an event type. For example, `1.0` or `2.0`.
  securitySchemes:
    Oauth2:
      type: oauth2
      description: Oauth 2.0 authentication
      flows:
        clientCredentials:
          tokenUrl: /v1/oauth2/token
          scopes:
            https://uri.paypal.com/services/applications/webhooks: Access/update Webhooks.
            https://uri.paypal.com/services/applications/verify-webhook-signature: Verify Webhook Signature

````