Skip to content
Developers
Get an API token

Send a test callback

POSTs one {"type": "export.test", "sent_at": <time>} to url, signed and checked as callback_url is (the host allowlist, https and public addresses only), with X-Export-Event: export.test, and answers with what the receiver did.

Send a test callback

POST/export-callbacks/test

POSTs one {"type": "export.test", "sent_at": <time>} to url, signed and checked as callback_url is (the host allowlist, https and public addresses only), with X-Export-Event: export.test, and answers with what the receiver did. No retries; up to 10 a minute per server (409 past it). A 200 says the test ran: ok says whether the receiver took it.

Send a Novi API token as a bearer token on every request. Authentication

Parameters

Query parameters

  • model_setstringOptional

    pattern ^[a-z0-9][a-z0-9-]{0,62}$

    The model set to answer from, an id from GET /model-sets. Absent: the set GET /model-sets names as default, the base dataset unless the server answers from a published set.

    • model_set=default reaches the base dataset; once the server retires it, a 400 naming the set answering instead.
    • An unknown id, or a set scoped to other tenants, is a 400 listing the ids the caller may use in details.allowed (published sets only once default is retired); a set that can't load, a 503 with the reason.
    • Plans and exports stay in their set: a call naming them (by path, plan, ids, source.plan, a scenario's plan.id, or a comparison's a.plan and b.plan, also under source.comparison) reaches it without model_set.
    • An explicit model_set wins; naming resources of two sets in one request is a 400.

Request bodyRequired

application/json

The URL to try.

  • urlstringRequired

    up to 2048 characters

    The callback URL to try.

Responses

200 OK

The delivery.

  • urlstringRequired

    The URL tried, as its origin with /… for any path or query.

  • okbooleanRequired

    Whether the receiver answered 2xx.

  • statusinteger or nullRequired

    Its HTTP status; null when none came back.

  • errorstring or nullRequired

    Why it failed: the receiver's status, a refused address, a timeout.

  • msintegerRequired

    ≥ 0

    How long it took.

Errors

StatusWhen
409

This server sent as many test callbacks in the last minute as it takes.

413

The request body is over 10 MB.

Shared errors400401403500503What they mean