API Reference (2024-09-02)

Download OpenAPI specification:Download

E-mail: support_developers@moveworks.ai

APIs to build new integrations with Moveworks. Our base URL is api.moveworks.ai.

Events

Send a message for an event

Send a message to a list of recipients for an event. The event must be defined in the Events Workspace.

SecurityBearer
Request
path Parameters
event_id
required
string <uuid>

ID of the event to notify for

Request Body schema: application/json
required
message
required
string [ 1 .. 20000 ] characters

Message to be sent, formatted in Moveworks' version of HTML. Moveworks attempts to shorten valid links to fit within chat platform constraints. Consult your chat platform API documentation to understand actual character limits.

recipients
required
Array of strings [ 1 .. 500 ] items

Email addresses of the employees to send the message to

object

Additional contextual data

Responses
200

Successfully scheduled

400

Bad Request

401

Unauthenticated

403

Unauthorized

404

Event not found

429

Rate Limit Exceeded

post/rest/v1/events/{event_id}/messages/send
Request samples
application/json
{
  • "message": "This is a rich message that supports <b>bold</b> and <i>italics</i>.<br><br> Did I mention, we also support:<br><ul><li>Lists</li><li><a href=\"https://moveworks.com\">Links</a></li><li>and just about <a href=\"https://www.webfx.com/tools/emoji-cheat-sheet/\"> any emoji you want </a>:fire:</li></ul>",
  • "recipients": [
    ],
  • "context": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}

Authentication

Create an OAuth token

Generate an Access Token using OAuth 2.0 Client Credentials for authentication in subsequent API calls to other endpoints. See Credentials Management - OAuth 2.0 Client for more info.

Request
Request Body schema:
required
client_id
required
string

The client's unique identifier; acquired during the creation of credentials in Events Workspace.

client_secret
required
string

The client's secret key; acquired during the creation of credentials in Events Workspace.

grant_type
required
string

Specifies the type of grant being used for the token request. This should be set to "client_credentials".

Responses
200

Token created

400

Bad Request

401

Unauthenticated

429

Rate Limit Exceeded

500

Internal Server Error

post/oauth/v1/token
Request samples
{
  • "client_id": "15d8db87-9a06-4d5d-8e22-0b4e6c6c30a7",
  • "client_secret": "mws_ygD73mHVN9tgrScyFQZ8HIQRq9fNniNtuSuXMlt4wqu3E9Jit8wOoUVWLWblyUVDtW6lMz2QS6GTZqupMFD7RaiS8BucVVDH766b",
  • "grant_type": "client_credentials"
}
Response samples
application/json
{
  • "data": {
    }
}

Test API Key

SecurityBearer
Responses
200

Successfully tested

401

Unauthenticated

get/rest/v1/auth/test
Request samples 
Response samples 
application/json
{
  • "Message": "Auth tested successfully"
}
Deprecated
[Deprecated] Send a message
Send a message to users. This endpoint is deprecated, but existing integrations will continue to work.


SecurityBearer 
Request 
Request Body schema: application/json
required
Object containing all the data needed to send a message to a list of recipients


message
required
string  [ 1 .. 20000 ] characters 
Message to be sent, formatted in Moveworks' version of HTML. Moveworks attempts to shorten valid links to fit within chat platform constraints. Consult your chat platform API documentation to understand actual character limits.


 
recipients
required
Array of strings  [ 1 .. 500 ] items 
Email addresses of the employees to send the message to


 
Responses 
204
Successfully scheduled


400
Bad Request


401
Unauthenticated


403
Unauthorized


429
Rate Limit Exceeded


post/rest/v1/messages/send
Request samples 
application/json
{
  • "message": "This is a rich message that supports <b>bold</b> and <i>italics</i>.<br><br> Did I mention, we also support:<br><ul><li>Lists</li><li><a href=\"https://moveworks.com\">Links</a></li><li>and just about <a href=\"https://www.webfx.com/tools/emoji-cheat-sheet/\"> any emoji you want </a>:fire:</li></ul>",
  • "recipients": [
    ]
}
Response samples 
application/json
{
  • "code": "INVALID_VALUE_SIZE_TOO_SHORT",
  • "message": "Expected `message` field to be of min size: 1"
}