Send a signed sample event to the destination now, and get what it answered
One attempt, in this call: the answer says whether the destination returned 2xx, its status, how long it took and the beginning of what it said (third-party text). The sample is marked simulated, is not stored and is not retried; it works on a disabled destination too, to check a receiver before enabling it. To exercise the whole path (the event log, retries, the delivery log), use POST /v1/test/events in a test organization.
POST
https://api.invox.page/v1/webhook_endpoints/{id}/testAuthorization
Path parameters
Header parameters
Request body JSON required
Returns
200
What happened to the attempt. delivered: false is an answer, not an error.
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
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
JSON
404
not_found: The resource does not exist in this organization · webhook_endpoint_not_found: The webhook destination does not exist in this organization
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