API keys and webhooks

Connect other tools to Spodus in two ways. An API key lets another tool read and change your records. A webhook, built in Automations, sends data out when something changes or starts an automation from another app.

Before you start

• You need to be an owner or admin to see and create API keys.
• Webhooks in automations are included on the Starter and Growth plans.

Things to know

• A key acts as the person who made it, with their permissions. Keep it secret.
• You see the full key only once, when you create it. After that the list shows its start, who made it and when it was last used.
• Each key can make 600 requests a minute.
• Your plan sets how many API calls the whole workspace can make in a day (UTC): 25,000 on Free, 250,000 on Starter and 1,000,000 on Growth. Calls start again at midnight UTC.
• Deleting a record through the API moves it to the trash, as in the app.

Create an API key

1. Open your account menu and click Settings.
2. Under Workspace, click Developers.
3. Next to API keys, click New key.
4. Give the key a Name, such as the tool that will use it.
5. Click Create key.
6. Copy the key and store it somewhere safe. Click Done.

Use the API

Send the key as a bearer token in the Authorization header. Records come back as JSON. Settings > Developers lists the addresses under Using the API. You can list, read, create, update and delete records on any board.

• A board's key is the last part of its address in the app, like companies in /companies.
• Field keys are listed in Settings > Data model.

Revoke a key

1. Go to Settings > Developers.
2. Click Revoke on the key's row.
3. Click Revoke to confirm.

Anything using that key stops working at once. You can't undo this.

Set up webhooks

Webhooks live in Automations, so they run with the rest of your rules.

• To send data out when something changes, add a Send a webhook step to an automation. It posts to your URL.
• To start an automation from another app, use the Webhook trigger. The automation gets its own address to call.

See Webhooks for the steps.

Related

• Webhooks
• Apps
• Your first automation
• Audit log