There are two ways to connect your own software to OAKMONT. You call the API with a key, or OAKMONT calls your endpoint when something happens on your account. Both are set up under Organisation.
Creating an API key#
- Open Organisation and go to the chapter Developer API.
- Under Create a key, enter a Name that says where the key will be used, then press Create key.
- The card Your new API key shows the full key. Press Copy and store it somewhere safe now. It is shown once and never again.
Afterwards the list shows only a short prefix of each key, when it was created and when it was last used. An account can have up to 10 active keys.
Making the first call#
Send the key as a bearer token in the Authorization header. Your first call on the same page gives a ready command that scores one page and returns the findings as JSON. The API covers accessibility scanning and price quotes, and API docs opens the full reference.
Tokens#
Three tiles sit at the top of the chapter: Tokens used this month, Monthly tokens and Remaining. Every call counts against the quota. Once the tokens for the month are spent, calls are refused until the next month begins, unless you buy a token pack or move to a larger plan.
Revoking a key#
Press the bin icon on the row of a key and confirm with Revoke. Anything using that key stops working immediately, and this cannot be undone. Revoked keys stay in the list, marked as revoked.
Outbound webhooks#
In the chapter Integrations, scroll to Outbound webhooks. Enter a public https address under Endpoint URL and press Add webhook. The signing secret for that endpoint appears once. Copy it before you press Done. From then on OAKMONT sends signed JSON events to that address, for example when a job is completed or a monitored page gets worse. Each delivery carries an X-OAKMONT-Signature header, which you verify with the secret, and the event name and a timestamp in headers of their own.
Checking deliveries#
Send test on the row of a webhook sends a test event and reports the result. The badge beside the address shows how the last delivery went, with the HTTP status your server returned. Private and loopback addresses are refused. To stop deliveries to an endpoint, press the bin icon on its row and confirm with Remove.
