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

# Get webhook

> Retrieve a webhook by its ID.



## OpenAPI

````yaml api-reference/payment-acceptance/payment-acceptance-api.yaml get /api/v1/webhooks/{id}
openapi: 3.1.1
info:
  title: Coinbase Commerce API
  description: API for processing payments on the PaymentEscrow smart contract protocol.
  version: v0.0.1
servers:
  - url: https://payments.coinbase.com
security: []
tags:
  - name: Payments
    description: >-
      Endpoints focused on handling payment transactions.


      This includes operations for authorizing funds without immediate capture,
      and capturing previously authorized funds directly via the PaymentEscrow
      smart contract protocol. The endpoints help ensure secure and controlled
      payment processing, including verifying signatures, and updating payment
      statuses.
  - name: Rewards
    description: >-
      Endpoints for managing reward operations.


      These endpoints allow you to independently allocate, distribute, send, and
      deallocate rewards on previously successful payment operations.
  - name: Campaigns
    description: >-
      Endpoints for managing reward campaigns.


      Create and manage campaigns that integrate with the Flywheel smart
      contract to provide reward functionality. Campaigns allow merchants to
      define reward structures with customizable parameters including reward
      percentages and maximum limits.
  - name: coinbase.engine.operator_api.v1.OperatorApiService
paths:
  /api/v1/webhooks/{id}:
    get:
      tags:
        - Webhooks
      summary: Get webhook
      description: Retrieve a webhook by its ID.
      operationId: WebhooksApiService_GetWebhook
      parameters:
        - schema:
            type: string
          name: id
          description: The unique identifier of the webhook.
          in: path
          required: true
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/coinbase.engine.webhooks_api.v1.Webhook'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/google.rpc.Status'
      security:
        - Bearer: []
components:
  schemas:
    coinbase.engine.webhooks_api.v1.Webhook:
      type: object
      properties:
        entity:
          type: string
          description: Type of the entity, always "webhook".
          title: Entity
          examples:
            - webhook
        id:
          type: string
          description: Unique identifier for the webhook.
          title: ID
          examples:
            - wh_123456789
        operatorCoinbaseUserId:
          type: string
          description: Coinbase user ID of the operator this webhook belongs to.
          title: Operator Coinbase User ID
          examples:
            - f521747f-6fc8-4a1d-a765-625dcc86c0db
        identifier:
          type: string
          description: External identifier for clients.
          title: Identifier
          examples:
            - client-webhook-1
        description:
          type: string
          description: Human-readable description of the webhook's purpose.
          title: Description
          examples:
            - Payment notifications for order processing
        url:
          type: string
          description: The URL where webhook events will be sent.
          title: URL
          examples:
            - https://example.com/webhooks
        events:
          type: array
          items:
            $ref: '#/components/schemas/coinbase.engine.webhooks_api.v1.EventType'
          description: Types of events this webhook should receive.
          title: Events
          examples:
            - - EVENT_TYPE_PAYMENT_AUTHORIZED
              - EVENT_TYPE_PAYMENT_CAPTURED
              - EVENT_TYPE_PAYMENT_VOIDED
              - EVENT_TYPE_PAYMENT_REFUNDED
              - EVENT_TYPE_PAYMENT_CHARGED
              - EVENT_TYPE_REWARD_ALLOCATED
              - EVENT_TYPE_REWARD_DISTRIBUTED
              - EVENT_TYPE_REWARD_DEALLOCATED
              - EVENT_TYPE_REWARD_SENT
        secret:
          type: string
          description: Secret used for webhook signature verification.
          title: Secret
          examples:
            - whsec_abcdef1234567890
        status:
          $ref: '#/components/schemas/coinbase.engine.webhooks_api.v1.WebhookStatus'
          description: Status of the webhook (active, inactive).
          title: Status
          examples:
            - WEBHOOK_STATUS_ACTIVE
        createdAt:
          type: string
          format: date-time
          description: When the webhook was created.
          title: Created At
          examples:
            - '2023-01-01T00:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          description: When the webhook was last updated.
          title: Updated At
          examples:
            - '2023-01-02T00:00:00.000Z'
      description: Webhook configuration details.
      title: Webhook
      examples:
        - entity: webhook
          id: wh_123456789
          operatorCoinbaseUserId: op_987654321
          identifier: client-webhook-1
          description: Payment notifications for order processing
          url: https://example.com/webhooks
          secret: whsec_abcdef1234567890
          events:
            - EVENT_TYPE_PAYMENT_AUTHORIZED
            - EVENT_TYPE_PAYMENT_CAPTURED
            - EVENT_TYPE_PAYMENT_VOIDED
            - EVENT_TYPE_PAYMENT_REFUNDED
            - EVENT_TYPE_PAYMENT_CHARGED
            - EVENT_TYPE_REWARD_ALLOCATED
            - EVENT_TYPE_REWARD_DISTRIBUTED
            - EVENT_TYPE_REWARD_DEALLOCATED
            - EVENT_TYPE_REWARD_SENT
          status: WEBHOOK_STATUS_ACTIVE
          createdAt: '2023-01-01T00:00:00.000Z'
          updatedAt: '2023-01-02T00:00:00.000Z'
    google.rpc.Status:
      type: object
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
            type: object
    coinbase.engine.webhooks_api.v1.EventType:
      type: string
      enum:
        - EVENT_TYPE_PAYMENT_AUTHORIZED
        - EVENT_TYPE_PAYMENT_CAPTURED
        - EVENT_TYPE_PAYMENT_VOIDED
        - EVENT_TYPE_PAYMENT_REFUNDED
        - EVENT_TYPE_PAYMENT_CHARGED
        - EVENT_TYPE_REWARD_ALLOCATED
        - EVENT_TYPE_REWARD_DISTRIBUTED
        - EVENT_TYPE_REWARD_DEALLOCATED
        - EVENT_TYPE_REWARD_SENT
        - EVENT_TYPE_PAYMENT_RECONCILED
      description: List of supported events.
      title: EventType
      examples:
        - EVENT_TYPE_PAYMENT_AUTHORIZED
    coinbase.engine.webhooks_api.v1.WebhookStatus:
      type: string
      enum:
        - WEBHOOK_STATUS_ACTIVATED
        - WEBHOOK_STATUS_DEACTIVATED
      description: Enumeration of supported webhook statuses.
      title: WebhookStatus
      examples:
        - WEBHOOK_STATUS_ACTIVATED
    google.protobuf.Any:
      type: object
      properties:
        '@type':
          type: string
      additionalProperties: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: >-
        Authorization header using the Bearer scheme. Learn more about JWT
        tokens in the Coinbase Developer Portal.
      name: Authorization
      in: header

````