Send a test event now

POST/tenant/webhook/testProbar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

POST

/tenant/webhook/test

const url = 'http://localhost:3000/v1/tenant/webhook/test';
const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/v1/tenant/webhook/test \
  --header 'x-api-key: <x-api-key>'

Delivers a signed webhook.test to your URL and tells you whether it arrived: delivered, the HTTP status your server answered (if it answered) and a generic code in error. It saves you from finding out your webhook doesn’t work on the day you move money. Scope tenant:write or webhooks:write.

It doesn’t go through the event queue: it isn’t retried and doesn’t show up in GET /v1/events. Redirects are never followed: a 3xx is a failed delivery (redirect_not_followed); register the final URL. At most 5 calls per minute per account (429 rate_limited).

Authorizations

ApiKeyAuth

Responses

200

Resultado del intento de entrega

application/json

object

url

string

delivered

boolean

statusCode

HTTP status your server answered; null if it didn’t answer.

integer

nullable

durationMs

Kept for compatibility. Always 0: latency is not reported.

integer

error

Null when delivered. destination_not_allowed: the URL resolves to a non-public address. redirect_not_followed: your server answered 3xx. non_2xx_response: it answered something other than 2xx. unreachable: no connection or no answer within 5 s.

string

nullable

Allowed values: destination_not_allowed redirect_not_followed non_2xx_response unreachable

hint

string

Example

{
  "error": "destination_not_allowed"
}

422

No hay webhook registrado todavía (webhook_not_configured).

429

Más de 5 envíos de prueba por minuto en la cuenta (rate_limited).