> ## Documentation Index > Fetch the complete documentation index at: https://docs.hyperprop.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a webhook > Partial update — include only the fields you want to change. **Common operations:** - **Change URL:** `{ "url": "https://new-server.com/webhooks" }` - **Change subscribed events:** `{ "events": ["*"] }` - **Disable (stop receiving events):** `{ "isActive": false }` - **Re-enable:** `{ "isActive": true }` — this also resets the failure count to 0 **Automatic catch-up on re-enable:** while an endpoint is disabled (manually or auto-disabled after consecutive failures), no deliveries are attempted or recorded for it. When you re-enable it, the events it missed during the disabled window are automatically re-dispatched to it, oldest first (up to 500 events, looking back at most 7 days), and any deliveries that failed terminally just before the disable are retried. `fill.created` is **not** included in catch-up — recover missed fills via the event stream's `?since=` replay or `GET /platform/v1/organization/snapshots/fills`. Catch-up deliveries are normal deliveries: same payloads (account state is rendered at send time), same signatures, and the original event `id` and `createdAt` — dedupe as usual. **Note:** To change the signing secret, use the dedicated rotate-secret endpoint instead. **Authentication:** send your organization API key in the `X-API-Key` header. ## OpenAPI ````yaml /api-reference/openapi.json put /v1/organization/webhooks/{webhookId} openapi: 3.0.0 info: title: Hyperprop Platform API version: 1.0.0 description: >- REST API for the Hyperprop Trading Platform — provision evaluation and funded trading accounts, manage traders and plans, react to account lifecycle events via signed webhooks, and reconcile billing. Built for prop firms integrating from their own backend. Authentication, quick start, error handling, idempotency, pagination, custom metadata, webhooks, and the MCP connector are documented at https://docs.hyperprop.com. x-logo: url: https://app.hyperprop.com/logo-icon.svg altText: Hyperprop href: https://hyperprop.com servers: - url: https://api.hyperprop.com/platform description: Production security: [] tags: - name: Trading accounts description: Create, update, and inspect trading accounts. - name: Traders description: Look up and update the traders in your organization. - name: Trading plans description: Define the plans you sell. - name: Trading rules description: Define how accounts are evaluated. - name: Lockouts description: Pause and resume trading on an account. - name: Payouts description: Check payout eligibility and record payouts. - name: Purchases description: Purchases recorded for your organization. - name: Time Machine description: Restore accounts to an earlier trading day or instant. - name: Webhooks description: Register webhook endpoints and inspect deliveries. - name: Events description: Your organization's event history and real-time event stream. - name: Reconciliation description: Balances, end-of-day snapshots, and fills for reconciliation. - name: Analytics description: Organization performance and plan economics. - name: Billing description: 'Your Hyperprop bill: activity, billing cycles, and forecasts.' - name: Team and roles description: Manage dashboard access for your staff. - name: API keys description: Manage your organization's API key. - name: Logs and health description: API request logs, the audit log, and integration health. - name: Organization profile description: Your organization's profile and logo. - name: Support description: Open and follow up on support tickets. - name: Partner access description: >- Read a trader's journal as an approved partner app, with the trader's own key. paths: /v1/organization/webhooks/{webhookId}: put: tags: - Webhooks summary: Update a webhook description: >- Partial update — include only the fields you want to change. **Common operations:** - **Change URL:** `{ "url": "https://new-server.com/webhooks" }` - **Change subscribed events:** `{ "events": ["*"] }` - **Disable (stop receiving events):** `{ "isActive": false }` - **Re-enable:** `{ "isActive": true }` — this also resets the failure count to 0 **Automatic catch-up on re-enable:** while an endpoint is disabled (manually or auto-disabled after consecutive failures), no deliveries are attempted or recorded for it. When you re-enable it, the events it missed during the disabled window are automatically re-dispatched to it, oldest first (up to 500 events, looking back at most 7 days), and any deliveries that failed terminally just before the disable are retried. `fill.created` is **not** included in catch-up — recover missed fills via the event stream's `?since=` replay or `GET /platform/v1/organization/snapshots/fills`. Catch-up deliveries are normal deliveries: same payloads (account state is rendered at send time), same signatures, and the original event `id` and `createdAt` — dedupe as usual. **Note:** To change the signing secret, use the dedicated rotate-secret endpoint instead. **Authentication:** send your organization API key in the `X-API-Key` header. operationId: putV1OrganizationWebhooksWebhookid parameters: - description: Webhook ID x-format: guid: true name: webhookId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Model854' responses: '200': description: Webhook updated content: '*/*': schema: $ref: '#/components/schemas/Model855' '400': description: Validation failed content: '*/*': schema: $ref: '#/components/schemas/Model19' '401': description: Authentication required content: '*/*': schema: $ref: '#/components/schemas/Model9' '403': description: Access denied content: '*/*': schema: $ref: '#/components/schemas/Model47' '404': description: Webhook not found content: '*/*': schema: $ref: '#/components/schemas/Model368' '500': description: An unexpected error occurred content: '*/*': schema: $ref: '#/components/schemas/Model5' security: - X-API-Key: [] components: schemas: Model854: type: object properties: url: type: string description: New endpoint URL (HTTPS required) example: https://new-server.com/webhooks x-format: uri: scheme: https events: $ref: '#/components/schemas/Model853' description: type: string description: Updated label example: Updated production webhook maxLength: 255 isActive: type: boolean description: >- Set to false to pause delivery, true to resume (resets failure count) example: false Model855: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/Model164' message: type: string example: Webhook updated successfully Model19: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 400 error: type: string example: Bad Request message: type: string example: Validation failed code: type: string description: Machine-readable error code — switch on this, not on message text example: VALIDATION_ERROR Model9: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 401 error: type: string example: Unauthorized message: type: string example: Authentication required code: type: string description: Machine-readable error code — switch on this, not on message text example: UNAUTHORIZED Model47: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 403 error: type: string example: Forbidden message: type: string example: Access denied code: type: string description: Machine-readable error code — switch on this, not on message text example: FORBIDDEN Model368: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 404 error: type: string example: Not Found message: type: string example: Webhook not found code: type: string description: Machine-readable error code — switch on this, not on message text example: NOT_FOUND Model5: type: object properties: success: type: boolean description: Always false on errors example: false statusCode: type: number example: 500 error: type: string example: Internal Server Error message: type: string example: An unexpected error occurred code: type: string description: Machine-readable error code — switch on this, not on message text example: INTERNAL_ERROR Model853: type: array description: Updated event subscriptions example: - '*' minItems: 1 items: $ref: '#/components/schemas/Model852' Model164: type: object properties: id: type: string description: Unique webhook ID example: d2f3a1c0-8e7b-4f6a-9c5d-1234567890ab x-format: guid: true url: type: string description: Endpoint URL that receives webhook POSTs example: https://your-server.com/webhooks/hyperprop x-format: uri: true events: $ref: '#/components/schemas/Model163' description: type: string description: Optional label to identify this webhook example: Production webhook isActive: type: boolean description: >- Whether the webhook is currently active. Disabled webhooks receive no events. example: true failureCount: type: number description: >- Consecutive delivery failures. Resets to 0 on any successful delivery or re-enable. Auto-disables at 25. example: 0 disabledAt: type: string description: Timestamp when the webhook was auto-disabled, if applicable. example: '2026-03-28T22:00:00.000Z' disabledReason: type: string description: Reason the webhook was disabled, if applicable. example: Auto-disabled after 25 consecutive delivery failures lastTriggeredAt: type: string description: Timestamp of the last delivery attempt example: '2026-03-28T21:30:00.000Z' createdAt: type: string example: '2026-03-28T21:00:00.000Z' updatedAt: type: string example: '2026-03-28T21:30:00.000Z' Model852: type: string enum: - '*' - account.created - account.status_changed - account.updated - account.imported - account.unlinked - account.passed - account.failed - account.lockout_created - account.lockout_removed - account.lockout_updated - account.payout_processed - account.max_payouts_reached - purchase.created - purchase.status_changed - trader.created - snapshot.ready - fill.created - account.balance_changed Model163: type: array description: Event types this webhook subscribes to. Use ["*"] for all. example: - account.created - account.status_changed items: type: string securitySchemes: X-API-Key: type: apiKey name: X-API-Key in: header description: >- Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard. ```` ## Related topics - [Delete a webhook](/platform-api/webhooks/delete-a-webhook.md) - [Update a trader](/platform-api/traders/update-a-trader.md) - [Update a trading account](/platform-api/trading-accounts/update-a-trading-account.md) - [Webhooks](/guides/webhooks.md) - [Update a custom role](/platform-api/team-and-roles/update-a-custom-role.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.