> ## Documentation Index > Fetch the complete documentation index at: https://mintfax.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update Webhook Endpoint > Updates an existing webhook endpoint. ## OpenAPI ````yaml /openapi.json put /webhooks/{webhook} openapi: 3.1.0 info: title: mintfax API version: '1.0' description: >- Developer-first fax API. Send faxes with a single API call. ## Authentication Most endpoints require a Bearer token in the `Authorization` header. - **Account keys** (`mfx_acct_...`) access account-level endpoints (`/account`, `/account/balance`, `/account/transactions`, `/account/keys`). - **Environment keys** (`mfx_test_...` for test, `mfx_live_...` for live) access operational endpoints (`/environment`, `/faxes`, `/webhooks`, `/events`). - Registration endpoints (`POST /account/register` and `POST /account/register/verify`) do not require authentication. ## Base URL All API requests use `https://api.mintfax.com/v1` as the base URL. contact: name: mintfax Support email: support@mintfax.com url: https://mintfax.com/docs servers: - url: https://api.mintfax.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: >- Account-level resources: registration, account info, balances, and API keys. - name: Environment description: >- Test and live environment configuration shared across all operational requests. - name: Fax description: Send, list, retrieve, resend, and purge faxes. - name: Events description: >- Read the immutable event log for everything that has happened in the environment. - name: Webhooks description: >- Manage webhook endpoints and inspect or replay individual delivery attempts. paths: /webhooks/{webhook}: put: tags: - Webhooks summary: Update Webhook Endpoint description: Updates an existing webhook endpoint. operationId: updateWebhookEndpoint parameters: - name: webhook in: path required: true description: The webhook public id schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWebhookEndpointRequest' responses: '200': description: '`WebhookEndpointResource`' content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/WebhookEndpointResource' required: - data '401': description: The provided API key is not recognised. content: application/json: schema: $ref: '#/components/schemas/Error' examples: api_key_invalid: value: error: api_key_invalid message: The provided API key is not recognised. action: check_credentials docs: https://mintfax.com/docs/errors/api-key-invalid '403': description: >- Live calls require account activation. Complete a first credit purchase to activate. content: application/json: schema: $ref: '#/components/schemas/Error' examples: account_not_activated: value: error: account_not_activated message: >- Live calls require account activation. Complete a first credit purchase to activate. action: activate_account docs: https://mintfax.com/docs/errors/account-not-activated key_not_scoped_for_operations: value: error: key_not_scoped_for_operations message: >- This API key cannot send faxes or read environment data. Use an mfx_test_ or mfx_live_ key. action: use_operational_key docs: >- https://mintfax.com/docs/errors/key-not-scoped-for-operations '404': description: The requested resource was not found. content: application/json: schema: $ref: '#/components/schemas/Error' examples: not_found: value: error: not_found message: The requested resource was not found. action: verify_id docs: https://mintfax.com/docs/errors/not-found '422': description: The request failed validation. content: application/json: schema: $ref: '#/components/schemas/Error' examples: validation_failed: value: error: validation_failed message: The request failed validation. action: fix_request docs: https://mintfax.com/docs/errors/validation-failed context: errors: to: - The to field is required. file: - The file field is required. '500': description: >- An unexpected error occurred. Please retry; if the problem persists, contact support. content: application/json: schema: $ref: '#/components/schemas/Error' examples: internal_server_error: value: error: internal_server_error message: >- An unexpected error occurred. Please retry; if the problem persists, contact support. action: retry_or_contact_support docs: https://mintfax.com/docs/errors/internal-server-error components: schemas: UpdateWebhookEndpointRequest: type: object properties: url: type: string format: uri maxLength: 2048 is_active: type: boolean description: type: - string - 'null' maxLength: 255 events: type: - array - 'null' items: type: string enum: - fax.queued - fax.sending - fax.delivered - fax.failed - balance.low - balance.topup maxItems: 6 title: UpdateWebhookEndpointRequest WebhookEndpointResource: type: object properties: id: type: string description: Webhook endpoint identifier (we_-prefixed). url: type: string description: Destination URL receiving signed events. events: type: - array - 'null' description: |- Event types this endpoint subscribes to. Null means subscribed to all event types (the WebhookEndpoint::subscribesTo runtime treats null as "all"). examples: - - fax.delivered - fax.failed items: type: string is_active: type: boolean description: Whether the endpoint is currently delivering events. description: type: - string - 'null' description: Caller-provided description. created_at: type: string format: date-time description: UTC timestamp when the endpoint was created. updated_at: type: string format: date-time description: UTC timestamp when the endpoint was last updated. required: - id - url - events - is_active - description - created_at - updated_at title: WebhookEndpointResource Error: type: object properties: error: type: string description: Machine-readable error code. example: insufficient_balance message: type: string description: Human-readable description. example: Insufficient balance for this operation. action: type: string description: Suggested next step for the caller. example: top_up_balance docs: type: string format: uri description: URL to the docs entry for this error code. example: https://mintfax.com/docs/errors/insufficient-balance request_id: type: string description: >- Unique identifier for this API request, also returned in the X-Request-Id response header. Include this value in support requests for fast triage. pattern: ^req_[0-9A-HJKMNP-TV-Z]{26}$ example: req_01J9XYZQ8KH7B3R0WXAZP8VW6F context: type: object description: Error-specific extra fields (e.g. balances, validation errors). additionalProperties: [] required: - error - message - action - docs - request_id title: Error securitySchemes: bearerAuth: type: http description: |- API key as Bearer token. Use an account key (`mfx_acct_...`) for `/account/*` endpoints, and an environment key (`mfx_test_...` for sandbox, `mfx_live_...` for live) for `/environment/*`, `/faxes`, `/webhooks`, and `/events`. scheme: bearer ````