> ## Documentation Index > Fetch the complete documentation index at: https://docs.spritz.finance/llms.txt > Use this file to discover all available pages before exploring further. # Get webhooks > Returns all webhooks configured for the integrator. ## OpenAPI ````yaml https://platform.spritz.finance/openapi.json get /v1/integrator/webhooks openapi: 3.0.3 info: title: Spritz Finance API version: 1.0.0 description: API for the Spritz Finance platform with RFC 9457 error handling servers: - url: https://platform.spritz.finance description: Production - url: https://sandbox.spritz.finance description: Sandbox security: [] tags: - name: Users description: User management endpoints - name: Bank Accounts description: Manage bank accounts for off-ramp destinations - name: Bills description: Manage bill pay accounts - name: Cards description: Spritz-issued debit cards - name: Auto-Ramp Accounts description: Virtual bank accounts that automatically convert fiat deposits to crypto - name: Spritz App description: >- Endpoints used by the Spritz app and internal SDKs. Excluded from the public partner spec. paths: /v1/integrator/webhooks: get: tags: - Integrator summary: Get webhooks description: Returns all webhooks configured for the integrator. operationId: getV1IntegratorWebhooks responses: '200': description: List of webhooks configured for the integrator content: application/json: schema: description: List of webhooks configured for the integrator type: array items: type: object properties: id: description: Unique identifier for the webhook type: string example: 6a9fee5c215e5530b3530e7c events: description: List of event types this webhook is subscribed to type: array items: type: string enum: - account.created - account.updated - account.deleted - payment.created - payment.updated - payment.completed - payment.refunded - verification.status.updated - capabilities.updated - onramp.created - onramp.updated - onramp.completed - achDebitReturn.created - achDebitReturn.updated - achDebit.authorized - achDebit.deliveryProgress - achDebit.delivered - achDebit.refunded - achDebit.returned - offramp.confirmed - offramp.inFlight - offramp.completed - offramp.failed - offramp.refunded - offramp.reversed - onrampCredit.depositDetected - onrampCredit.completed - onrampCredit.failed - onrampCredit.reversed - onrampCredit.refunded - '*' url: description: URL to which webhook payloads are delivered format: uri type: string example: https://api.example.com/webhooks failureCount: description: Number of consecutive delivery failures minimum: 0 type: number example: 0 disabled: description: Whether the webhook is currently disabled type: boolean example: false required: - id - events - url - failureCount - disabled '401': description: Response for status 401 content: application/problem+json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 401 detail: description: A human-readable explanation specific to this occurrence type: string example: Bearer token required instance: description: A URI reference that identifies the specific occurrence type: string realm: description: The authentication realm type: string example: API scope: description: The required scope for this resource type: string example: read:users required: - title - status additionalProperties: false '404': description: Response for status 404 content: application/problem+json: schema: type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string title: description: A short, human-readable summary of the problem type type: string status: description: The HTTP status code type: number example: 404 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string resourceType: description: The type of resource that was not found type: string example: user resourceId: description: The identifier of the resource that was not found type: string required: - title - status - resourceType - resourceId additionalProperties: false '500': description: Response for status 500 content: application/problem+json: schema: additionalProperties: true type: object properties: type: default: about:blank description: A URI reference that identifies the problem type type: string example: urn:problem-type:auth:unauthorized title: description: A short, human-readable summary of the problem type type: string example: Unauthorized status: description: The HTTP status code type: number example: 400 detail: description: A human-readable explanation specific to this occurrence type: string instance: description: A URI reference that identifies the specific occurrence type: string example: /errors/1234567890 code: description: >- Machine-readable cause, present when exactly one thing failed. Branch on this, never on `detail`, which is human-facing copy and may change. For deposit limits the vocabulary matches the `reason` values the limits API returns pre-flight. type: string example: transaction_limit field: description: The offending request field, present alongside `code`. type: string example: amountUsd retryable: description: >- Whether retrying the same request later may succeed without changing its inputs. type: boolean example: true retryAfter: description: >- Seconds to wait before retrying, present alongside `retryable: true`. Mirrors the `Retry-After` response header and is meant for short backoffs the server chose (load shedding); for a condition that clears on its own schedule, `clearsAt` carries the absolute time instead. type: number example: 5 suggestedAction: type: string enum: - auto_ramp - wait_for_settlement clearsAt: format: date-time type: string description: >- Earliest known time the current temporary condition may clear. nullable: true availableAt: format: date-time type: string description: >- When a temporarily ineligible funding source may become available again. nullable: true permanent: description: >- Whether the current funding-source restriction will not clear automatically. type: boolean required: - title - status security: - hmacAuth: [] integratorKey: [] timestamp: [] components: securitySchemes: hmacAuth: type: apiKey in: header name: X-Signature description: >- HMAC signature authentication for backend integrators. **Required Headers:** - X-Integrator-Key: Integrator API key (format: ik_...) - X-Signature: HMAC signature (format: sha256={hex}) - X-Timestamp: Unix timestamp in milliseconds - Authorization: Bearer {user-api-key} **Signature Algorithm:** HMAC-SHA256 **Signature Format:** {timestamp}.{METHOD}.{path}.{bodyHash} - timestamp: Unix timestamp in milliseconds - METHOD: HTTP method in UPPERCASE (GET, POST, etc.) - path: Request path (e.g., /v1/transactions) - bodyHash: SHA256 hex digest of request body (empty string if no body) **Timestamp Tolerance:** ±5 minutes (300 seconds) **Example:** For POST /v1/transactions with body {"amount":100} and timestamp 1234567890000: Payload: 1234567890000.POST./v1/transactions.{sha256(body)} Signature: sha256=abc123... integratorKey: type: apiKey in: header name: X-Integrator-Key description: 'Integrator API key (format: ik_...) used with HMAC authentication' timestamp: type: apiKey in: header name: X-Timestamp description: >- Unix timestamp in milliseconds for request freshness. Must be within 5 minutes of server time. The timestamp alone bounds but does not prevent an exact replay within that window. Use Idempotency-Key on supported mutations. ````