Skip to main content

Weavix & API's

Updated

Want to connect Weavix with other software systems?


That’s exactly what the Weavix REST API is for.

Before you begin, make sure API access is enabled for your instance. If you don’t have access yet, contact help@weavix.com.

What is the REST API?

Think of the Weavix API as a translator between Weavix and other software platforms.

It allows systems to:

  • Pull information out of Weavix
  • Send information into Weavix
  • Automate repetitive tasks
  • Connect Weavix with other tools

What Can You Do With It?

Here are a few common examples:

Sync Employees

Automatically import employees from your HR or workforce management system into Weavix.

Automate Tasks

Automatically create users, channels, or workflows.

Connect Third-Party Tools

Integrate Weavix with the systems your team already uses.

Step 1: Create an API Key

Before making API requests, you’ll need an API Key.

How to Create One

  1. Open the Weavix Console:
    https://console.weavix.com
  2. Navigate to:
    Configuration → API Keys

Don’t see API Keys? Reach out to your Weavix administrator.

  1. Click:
    Add API Key
  2. Give your key a name.

Example Names

  • HR Integration
  • Device Reporting
  1. Copy and securely save the following:
  • Secret
  • Authorization Token
  1. Close the window.

Important Security Tip

Your Authorization Token is like a password for the API.

Anyone with this token may be able to access your Weavix data based on your permissions.

  • Store it securely
  • Never share it publicly

Step 2: Make Your First API Request

Every API request must include your Authorization Token.

This tells Weavix:

“This request is authorized.”

Example Request

curl -X GET \
-H "Authorization: YOUR_AUTHORIZATION_TOKEN" \
https://api.weavix.com/v1/core/people

Breaking Down the Request

Part What It Means
GET “I want to retrieve information”
Authorization Your secure API access token
/people The Weavix data endpoint you’re requesting

API Documentation

Ready to explore more endpoints and examples?

Visit the full documentation here:

Weavix REST API Documentation

You’re Ready to Build

Once connected, the possibilities are endless:

  • Automate workflows
  • Sync workforce data
  • Build integrations
  • Extend the power of Weavix

Related articles

Comments

0 comments

Article is closed for comments.