> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve webhook > Retrieves the details of an existing webhook. Required permissions: - `developer:manage_webhook` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /webhooks/{id} openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /webhooks/{id}: get: tags: - Webhooks summary: Retrieve webhook description: |- Retrieves the details of an existing webhook. Required permissions: - `developer:manage_webhook` operationId: retrieveWebhook parameters: - description: The unique identifier of the webhook to retrieve. in: path name: id required: true schema: example: hook_xxxxxxxxxxxxx type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Webhook' description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - developer:manage_webhook x-codeSamples: - lang: JavaScript source: |- import Whop from '@whop/sdk'; const client = new Whop({ apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted }); const webhook = await client.webhooks.retrieve('id'); console.log(webhook.id); components: schemas: Webhook: description: >- A webhook endpoint that receives event notifications for a company via HTTP POST. properties: api_version: $ref: '#/components/schemas/ApiVersion' description: >- The API version used to format payloads sent to this webhook endpoint. api_version_date: description: >- The dated API version (Api-Version-Date) that v1 payloads for this endpoint are pinned to: events serialize exactly like a REST read at this version (the native serializer where the resource has one). Null when unpinned — legacy (v2/v5) webhooks, and v1 webhooks on the legacy payload shape. type: - string - 'null' child_resource_events: description: >- Whether events are sent for child resources. For example, if the webhook is on a company, enabling this sends events only from the company's sub-merchants (child companies). type: boolean created_at: description: The datetime the webhook was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string enabled: description: >- Whether this webhook endpoint is currently active and receiving events. type: boolean events: description: The list of event types this webhook is subscribed to. items: $ref: '#/components/schemas/WebhookEvent' type: array id: description: The unique identifier for the webhook. example: hook_xxxxxxxxxxxxx type: string resource_id: description: >- The ID of the resource (company or product) this webhook is attached to. type: string testable_events: description: >- The subset of subscribed event types that support sending test payloads. items: $ref: '#/components/schemas/WebhookEvent' type: array url: description: >- The destination URL where webhook payloads are delivered via HTTP POST. example: https://example.com/path type: string webhook_secret: description: >- The secret key used to sign webhook payloads for verification. Include this in your HMAC validation logic. Returned on the create response and to interactive dashboard sessions; empty for API-key and OAuth callers on later reads. example: whsec_abc123def456 type: string required: - id - url - enabled - events - api_version - api_version_date - created_at - child_resource_events - webhook_secret - resource_id - testable_events type: object ApiVersion: description: The different API versions enum: - v1 - v2 - v5 type: string WebhookEvent: description: The different event types available enum: - account.updated - invoice.created - invoice.marked_uncollectible - invoice.paid - invoice.past_due - invoice.voided - membership.activated - membership.deactivated - membership.trial_ending_soon - entry.created - entry.approved - entry.denied - entry.deleted - export.completed - export.failed - setup_intent.requires_action - setup_intent.succeeded - setup_intent.canceled - ledger_account.funds_available - swap.completed - deposit.succeeded - transfer.created - transfer.completed - transfer.failed - withdrawal.created - withdrawal.updated - withdrawal.reversed - card_transaction.created - card_transaction.updated - card_transaction.completed - card_transaction.declined - card_transaction.reversed - card.created - card.updated - card.frozen - card.canceled - card_application.created - card_application.updated - card_application.approved - card_application.denied - course_lesson_interaction.completed - payout_method.created - verification.succeeded - identity_profile.approved - identity_profile.rejected - identity_profile.needs_action - identity_profile.updated - payout_account.status_updated - resolution_center_case.created - resolution_center_case.updated - resolution_center_case.decided - product.created - product.updated - product.deleted - product.published - product.unpublished - plan.created - plan.updated - plan.deleted - shipment.created - shipment.updated - member.created - ad_campaign.payment_failed - chat.message.created - chat.reaction.created - payment.created - payment.succeeded - payment.failed - payment.pending - dispute.created - dispute.updated - refund.created - refund.updated - dispute_alert.created - membership.cancel_at_period_end_changed type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````