> ## Documentation Index > Fetch the complete documentation index at: https://docs.nxos.io/llms.txt > Use this file to discover all available pages before exploring further. # Create endpoint > Register a webhook endpoint for the calling organization. ## OpenAPI ````yaml POST /v1/webhooks/endpoints openapi: 3.0.0 info: title: nxos API version: 1.0.0 contact: name: nxos url: https://nxos.io description: |- The nxos platform API provides programmatic access to accounts, balances, quotes, and trades. All endpoints require API key authentication. servers: - url: https://api.nxos.io description: Production variables: {} - url: https://api.sandbox.nxos.io description: Sandbox variables: {} security: [] tags: - name: Accounts - name: Quotes - name: Beneficiaries - name: Fiat Payouts - name: Crypto Payouts - name: Sandbox Faucet - name: Nxosnet - name: Fees - name: Funding Methods - name: Transactions - name: Organizations - name: Authorizations - name: Webhooks description: >- Register an HTTPS endpoint to receive events (organization verification and transaction status changes) instead of polling. Deliveries are signed; verify the `svix-signature` header before acting on an event. See the [Webhooks guide](https://docs.nxos.io/core-concepts/webhooks) for the delivery format, signature verification, retries, and broker behavior. Payload shapes are documented in the `…Event` models below. paths: /v1/webhooks/endpoints: post: tags: - Webhooks description: Register a webhook endpoint for the calling organization. operationId: Webhooks_create parameters: - $ref: '#/components/parameters/ApiKeyAuth' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWebhookEndpointRequest' responses: '200': description: The request has succeeded. content: application/json: schema: $ref: '#/components/schemas/WebhookEndpoint' '401': description: Access is unauthorized. content: application/json: schema: $ref: '#/components/schemas/Error401' '422': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error400' '429': description: Client error content: application/json: schema: $ref: '#/components/schemas/Error429' '500': description: Server error content: application/json: schema: $ref: '#/components/schemas/Error500' '502': description: Server error content: application/json: schema: $ref: '#/components/schemas/Error502' components: parameters: ApiKeyAuth: name: Authorization in: header required: true description: 'Bearer token. Format: `Bearer `' schema: type: string schemas: CreateWebhookEndpointRequest: type: object required: - url properties: url: type: string description: HTTPS URL that will receive webhook deliveries. eventTypes: type: array items: type: string description: Event types to subscribe to. Omit to receive all event types. description: type: string description: Optional human-readable description. description: Request body for registering a webhook endpoint. example: url: https://example.com/webhooks/nxos eventTypes: - organization.verification.updated - transaction.status.updated description: Production receiver WebhookEndpoint: type: object required: - object - id - url - description - disabled - eventTypes - createdAt - updatedAt properties: object: type: string enum: - webhook_endpoint description: Object type. Always `webhook_endpoint`. id: type: string description: Unique endpoint identifier. url: type: string description: HTTPS URL that receives webhook deliveries. description: type: string description: Optional human-readable description. disabled: type: boolean description: When true, the endpoint stays registered but receives no deliveries. eventTypes: type: array items: type: string description: >- Event types this endpoint is subscribed to. Empty means all event types. createdAt: allOf: - $ref: '#/components/schemas/dateTimeString' description: When the endpoint was created. updatedAt: allOf: - $ref: '#/components/schemas/dateTimeString' description: When the endpoint was last updated. description: >- A registered webhook endpoint. Delivery, retries, and signing are handled by Svix. example: object: webhook_endpoint id: ep_a1b2c3d4e5f6a1b2c3d4e5f6 url: https://example.com/webhooks/nxos description: Production receiver disabled: false eventTypes: - transaction.status.updated createdAt: '2026-06-08T12:00:00Z' updatedAt: '2026-06-08T12:00:00Z' Error401: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: missing_api_key message: No Authorization header provided. requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 Error400: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: invalid_request message: The request body is malformed or missing required fields. requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 Error429: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: rate_limited message: 'Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.' requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 Error500: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: internal_error message: An unexpected server error occurred. requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 Error502: type: object required: - error properties: error: $ref: '#/components/schemas/ErrorBody' description: Standard error response returned by all endpoints on failure. example: error: code: chain_send_failed message: On-chain transaction failed. requestId: req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4 dateTimeString: type: string description: ISO 8601 timestamp string. ErrorBody: type: object required: - code - message - requestId properties: code: allOf: - $ref: '#/components/schemas/ErrorCode' description: Machine-readable error code. message: type: string description: Human-readable error message. requestId: type: string description: Unique identifier for this request, useful for debugging. ErrorCode: type: string enum: - missing_api_key - authentication_failed - invalid_api_key - forbidden - swap_direction_not_allowed - service_not_enabled - not_found - organization_not_found - account_not_found - quote_not_found - beneficiary_not_found - transaction_not_found - funding_method_not_found - authorization_not_found - nxosnet_handle_not_found - quote_expired - quote_already_used - beneficiary_already_archived - beneficiary_not_archived - beneficiary_blocked - nxosnet_not_enabled - nxosnet_handle_taken - chain_send_failed - idempotency_key_in_use - idempotency_request_in_flight - invalid_request - insufficient_funds - validation_error - share_token_invalid - verification_import_unsupported - verification_required - rate_limited - webhooks_unavailable - internal_error description: All possible error codes returned by the API. ````