Account

Use the API and webhooks

Create API keys and webhook endpoints to connect Velstrian Tenderworks to your own systems, and see delivery history.

5 min read

What this is for

The API and webhooks screen is for connecting Velstrian Tenderworks to your own software. An API key lets your systems read or write through the application programming interface, the controlled way one program talks to another. A webhook is a message Velstrian Tenderworks sends to a web address you choose when something happens, so your systems can react. The screen also shows delivery history, a log of the webhook messages that were sent and whether they arrived.

A plan level feature with a permission

API access is part of the Integrations capability. It is included on the Portfolio plan and is a paid add on for the Pro plan. On a plan without it, the API keys section shows a locked state that explains the upgrade, while the delivery history stays visible. Managing webhook endpoints also needs the manage integrations permission, so a team member without it can look but not change. Pricing and upgrades are an owner decision through billing.

Step by step

  1. Open Settings, then API & webhooks.
  2. In the endpoints section, add a webhook endpoint, the web address that should receive messages.
  3. Create an API key for your systems if your plan includes it. Give it a name and only the scopes it needs. The key is shown once, so copy it then and store it safely. Treat it like a password and never paste it into a tender answer or any shared document.
  4. Use the deliveries section to check what was sent and whether it succeeded.

What happens next

Once an endpoint is set up, Velstrian Tenderworks sends it a message each time the matching event happens, and the delivery history records the result. If a delivery fails, the history is where you see it. The same screen links to the API documentation, which lists every endpoint and how to sign in to it.

Common problems

The API keys section is locked: your plan does not include Integrations, and the panel names the plan that unlocks it. You cannot add an endpoint: that needs the manage integrations permission, so ask an owner or admin. A key has been lost: keys are shown only once, so revoke the old key and create a new one.