Fabricate an event about a test invoice, to exercise a receiver
Writes an event of type about the invoice invoice_id, marked simulated: true in the event log, in GET /v1/events and in the webhook. It travels every channel a real event does and raises no alert. Nothing happens to the invoice: data.invoice is the invoice as it IS, whatever the type says. For an invoice that really reaches an outcome, issue one with the Test-Scenario header. Only the types about an invoice can be simulated (can_be_simulated in GET /v1/event_types).
POST
https://api.invox.page/v1/test/eventsAuthorization
Header parameters
Request body JSON required
Returns
200
A retry: the event the first request wrote.
JSON
201
The simulated event, as GET /v1/events lists it.
JSON
400
organization_required: This credential needs to say which organization it acts on · validation_failed: The request is not valid · malformed_request: The request body is not valid JSON · idempotency_key_required: This write needs an Idempotency-Key header
JSON
401
unauthenticated: No credential was sent · invalid_credential: The credential is not valid
JSON
403
missing_scope: The credential lacks the permission this operation requires · organization_mismatch: The X-Organization header names another organization than the key's · organization_archived: The organization is archived · test_only_route: This route only exists in a test organization
JSON
404
not_found: The resource does not exist in this organization
JSON
422
idempotency_key_reused: This Idempotency-Key was already used with a different request
JSON
429
rate_limited: Too many requests
JSON
500
internal_error: The service failed
JSON
503
service_unavailable: The service cannot answer right now
JSON