> ## Documentation Index > Fetch the complete documentation index at: https://vexioncards.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Send a test event > Sends a synthetic event to the endpoint **synchronously** and returns the delivery result - wire up your receiver, then prove the whole path (TLS, signature verification, 2xx) in one call before going live. - Default event: `type: "ping"` with an empty `data.object` - signed exactly like production deliveries - Or pass `event_type` to receive a realistic **example payload** of any catalog event - The attempt does NOT count toward auto-disable and is not retried - the response tells you what happened immediately Rate limit: 10 test sends per endpoint per minute. A test send is not recorded as a delivery: it creates no delivery row, so it will NOT appear in `GET /v1/webhook_endpoints/{id}/deliveries`. The inline response below is the only record of the attempt. ## OpenAPI ````yaml /openapi.json post /v1/webhook_endpoints/{id}/test openapi: 3.1.0 info: title: VEXiON cards Public API description: >- ## Rate limiting Two independent layers, checked in this order: 1. **Per-IP throttle (pre-authentication).** Applied to every `/v1` request BEFORE the API key is checked, keyed on the caller's IP address: - **600 requests/minute** per IP - a flood ceiling, `429 rate_limit_error` / `rate_limited`. - **20 failed authentications per 15 minutes** per IP - a key-guessing ceiling. Only responses that are `401` (missing/invalid/revoked key) count against this ceiling; a `403` from a valid key that simply lacks a scope does not. `429 rate_limit_error` / `too_many_failed_attempts`. Both ceilings send `Retry-After` (seconds). 2. **Per-key, per-bucket limiter (post-authentication).** Documented per endpoint (see each operation's `429` response and the `rate_limit` field on the API Key resource) - e.g. 60/min default, 120/min for transactions, plus the notification-broadcast and lookup-filter buckets described on their own endpoints. ### Rate-limit response headers Every rate-limited response carries the legacy `X-RateLimit-Limit` / `X-RateLimit-Remaining` / `X-RateLimit-Reset` family (the last is an **epoch timestamp**) AND the IETF standards-track headers, side by side: - `RateLimit-Policy: "";q=;w=` - the static policy for the bucket that was hit. - `RateLimit: "";r=;t=` - live state. **`t` is a DURATION (seconds remaining), not the epoch timestamp `X-RateLimit-Reset` carries - the two are never the same value.** version: 1.0.0 servers: - url: https://api.vexioncards.one description: Production - url: https://migration.api.vexioncards.one description: Sandbox security: - apiKey: [] tags: - name: Customers - name: Cards - name: Transactions - name: Notifications - name: Locations - name: Products - name: API keys - name: Organization - name: Webhook endpoints - name: Events - name: Custom fields - name: Team members - name: Icons paths: /v1/webhook_endpoints/{id}/test: parameters: - name: id in: path required: true description: Endpoint identifier (`whk_` prefix). schema: type: string pattern: ^whk_[A-Za-z0-9]+$ example: whk_01J9MZX2Q4R8T6VBNM3KLP0D7S post: tags: - Webhook endpoints summary: Send a test event description: >- Sends a synthetic event to the endpoint **synchronously** and returns the delivery result - wire up your receiver, then prove the whole path (TLS, signature verification, 2xx) in one call before going live. - Default event: `type: "ping"` with an empty `data.object` - signed exactly like production deliveries - Or pass `event_type` to receive a realistic **example payload** of any catalog event - The attempt does NOT count toward auto-disable and is not retried - the response tells you what happened immediately Rate limit: 10 test sends per endpoint per minute. A test send is not recorded as a delivery: it creates no delivery row, so it will NOT appear in `GET /v1/webhook_endpoints/{id}/deliveries`. The inline response below is the only record of the attempt. operationId: testWebhookEndpoint parameters: - name: Idempotency-Key in: header required: true description: >- Required on every mutating POST. See [Idempotency](/api-reference/idempotency). schema: type: string minLength: 8 maxLength: 255 example: test-2c9d6b00-1a3f-4f9c-8a6f-2e10b9e34c12 requestBody: required: false content: application/json: schema: type: object properties: event_type: $ref: '#/components/schemas/WebhookEventName' description: >- Optional - send a realistic example of this catalog event instead of the default ping. examples: Ping: summary: Default connectivity check value: {} Realistic transaction: summary: Example transaction.created payload value: event_type: transaction.created responses: '200': description: Test delivery attempted - result inside. content: application/json: schema: type: object required: - object - delivered - response_code - latency_ms properties: object: type: string const: webhook_test_result description: Always `"webhook_test_result"`. delivered: type: boolean description: True when your receiver returned 2xx within 10 s. response_code: type: - integer - 'null' description: >- HTTP status your receiver returned; null on connection failure/timeout. latency_ms: type: integer description: Round-trip time of the attempt. error: type: - string - 'null' description: >- Failure reason when not delivered (e.g. 'timeout after 10000 ms', 'TLS handshake failed'). examples: Success: summary: Receiver verified value: object: webhook_test_result delivered: true response_code: 200 latency_ms: 184 error: null Receiver error: summary: Signature rejected downstream value: object: webhook_test_result delivered: false response_code: 401 latency_ms: 97 error: receiver returned 401 '400': description: >- Malformed body, missing required field, or missing Idempotency-Key header. content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Missing, invalid, or revoked API key. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Key lacks the required scope. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Webhook endpoint not found in your organization. content: application/json: schema: $ref: '#/components/schemas/Error' '413': description: >- Request body exceeds the 1 MB cap. The body was never parsed, so the request had no effect. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: invalid_request_error code: request_too_large message: The request body exceeds the maximum allowed size. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#request_too_large request_id: req_5f8b2c4a9e1d3 '422': description: >- One or more fields failed validation: invalid or non-routable url (webhook_url_invalid), a url whose host is unreachable at registration (webhook_url_unreachable), or an unknown event type. content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limited - respect Retry-After. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Server error. Retry-safe on idempotent calls. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: type: api_error code: internal_error message: >- An internal error occurred. The request may be retried with the same Idempotency-Key. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#internal_error request_id: req_5f8b2c4a9e1d3 examples: Http 500 default: summary: Http 500 default value: error: type: api_error code: internal_error message: >- An internal error occurred. The request may be retried with the same Idempotency-Key. doc_url: >- https://vexioncards.mintlify.site/api-reference/errors#internal_error request_id: req_5f8b2c4a9e1d3 headers: {} components: schemas: WebhookEventName: type: string enum: - customer.created - customer.updated - customer.deleted - customer.pass_installed - customer.pass_uninstalled - card.created - card.updated - card.deleted - custom_field.created - custom_field.updated - custom_field.deleted - product.created - product.updated - transaction.created - transaction.reversed - notification.sent - notification.delivery_updated - location.updated - team_member.added - team_member.updated - team_member.removed - webhook_endpoint.delivery_failed description: >- The locked v1 event catalog - 22 events across 9 subjects. Names follow `resource.action` with past-participle actions (`transaction.created`), never the dotted verb-stems used by transaction types - the two vocabularies never mix. `product.created`/`product.updated` fire for dashboard and API-created catalog changes; POS-synced catalog changes do not emit (they mirror the till, and a first sync would flood your endpoint). example: transaction.created Error: type: object required: - error properties: error: type: object required: - type - code - message properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - not_found_error - rate_limit_error - idempotency_error - api_error code: type: string message: type: string retry_after: type: integer description: >- Seconds to wait before retrying. Present on rate-limit (429) and idempotency-key-in-use (409) errors; mirrors the `Retry-After` HTTP header. Absent on error types that carry no retry guidance. example: 5 param: type: - string - 'null' request_id: type: string doc_url: type: string format: uri field_errors: type: array description: >- Per-field errors on a 422. At most 100 entries: a request with more errors gets the first 100. items: type: object properties: param: type: string code: type: string message: type: string expected_currency: type: string description: >- On `currency_mismatch`: the business currency the request must use. Absent on every other field error. description: >- The error payload: type (category), code (machine-readable), message (human-readable), retry_after (seconds, on rate-limit/idempotency-in-use errors only), param (offending field), request_id, doc_url, field_errors[]. description: >- Standard error envelope. Branch on `error.code`; include `error.request_id` in support requests. See the Errors guide. securitySchemes: apiKey: type: http scheme: bearer description: >- Your secret API key as a Bearer token: `Authorization: Bearer vxn_sk_...`. Keys are created and scoped in the dashboard - see [Authentication](/api-reference/introduction#authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.