API Reference

Download OpenAPI specification:Download

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

Authentication

Bearer

Security Scheme Type API Key
Header parameter name: Authorization

Send a message to a list of recipients

Send a message to users, referenced by email address, through the Moveworks Bot.

Request
Security:
Request Body schema: application/json

Object containing all the data needed to send a message to a list of recipients

message
required
string [ 1 .. 10000 ] characters

Message to be sent, formatted in Moveworks' version of HTML

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"
}

Validate your API Key

Request
Security:
Responses
200

Successfully scheduled

401

Unauthenticated

get/rest/v1/auth/test
Request samples
curl -i -X GET \
  https://api.moveworks.ai/rest/v1/auth/test \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Message": "Auth tested successfully"
}
Copyright © Moveworks 2022. All right reserved.