API and webhooks

The API and webhooks let your other tools work with DispatchMind. The API lets your own software read your DispatchMind data. Webhooks send a message to an address you choose the moment something happens, like a new job or a payment.

The API reads your jobs, customers and payments, and can add jobs, leads and notes. Full developer docs are at https://dispatchmind.ai/developers/.

Owners and admins manage both.

Where to find it

1. Open your account menu at the top right (your initials).
2. Pick Sign-in and security.
3. Choose Manage API keys and webhooks.

If you don't see it, your login isn't an owner or admin.

Make an API key

1. Open Manage API keys and webhooks.
2. Make a new API key. Keep a note of which tool it's for.
3. Copy the key right away and store it somewhere safe, like a password manager.

The key is shown once. If you lose it, revoke it and make a new one.

Treat an API key like a password. Anyone with it can read your company's data through the API. Don't paste it in emails or chat.

Revoke a key

Revoke a key when a tool is no longer used, a person who had it leaves, or you think it got out.

1. Open Manage API keys and webhooks.
2. Find the key.
3. Revoke it.

Anything using that key stops working right away. Make a new key for any tool that still needs access.

Add a webhook

A webhook sends a message to your system when something happens in DispatchMind. Your system needs an address that starts with https.

1. Open Manage API keys and webhooks.
2. Add a webhook and enter your https address.
3. Copy the signing secret right away. It's shown once.
4. Save.

What DispatchMind sends

• job.created when a new job is made
• job.updated when a job changes
• payment.received when a payment comes in

Each message is signed with your signing secret. Your system should check the signature so it knows the message really came from DispatchMind. The developer docs show how.

Ideas for using them

• Send new jobs into a shared spreadsheet or another tool your team uses.
• Post a note in your team chat when a payment comes in.
• Pull jobs and payments into your own reports.

If you don't write code yourself, hand this page and the developer docs to whoever does.

Good habits

• One key per tool. If one tool has a problem, revoke that key without breaking the rest.
• Write down what each key is for. Six months from now you'll want to know.
• Clean up. Revoke keys you no longer use.
• Keep secrets secret. Store keys and signing secrets in a password manager, not a note on your desktop.

Common questions

Can the API change jobs? It can add jobs, leads and notes. Changing a job's status stays with the office, and jobs are never deleted.

My webhook stopped getting messages. Check that your address still works and starts with https. Then check the status page. If it's still not working, write to support@dispatchmind.ai.

I lost my signing secret. It's only shown once. Check the developer docs or write to support@dispatchmind.ai for help getting a new one.

Related

• Sign-in and security
• Activity log