Create a webhook destination. Its signing secret is in this answer and nowhere else, ever
Events are POSTed to url, signed as Standard Webhooks (GET /v1/event_types explains the envelope, the signature and the retries). The test and the live half of an organization have separate destinations. A retry with the same Idempotency-Key returns the same destination WITHOUT its secret (secret: null). Without a public URL, follow events with GET /v1/events?wait=30 instead.
POST
https://api.invox.page/v1/webhook_endpointsAuthorization
Header parameters
Request body JSON required
Returns
200
A retry: the destination, without its secret.
JSON
201
The destination, with its secret.
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 · webhook_url_not_allowed: The URL of the webhook destination is not allowed
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
409
webhook_endpoint_limit_reached: The organization already has the maximum number of webhook destinations
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