Documentation

Oracle Create Message

Overview

This documentation provides details for using the createMessage action to add a message to an existing incident in Oracle Service Cloud. The createMessage action allows you to add a message (thread) to an incident, specifying whether the message is public or private. This action is using the REST API documented in the following documentation portal: https://docs.oracle.com/en/cloud/saas/b2c-service/cxsvc/op-services-rest-connect-v1.4-incidents-id-patch.html

Inputs

HostStringOracle host
UsernameStringOracle username
PasswordStringOracle password
IncidentIdStringID of the incident
MessageStringThe message content
IsPrivateBooleanWhether the message is private

Outputs

SuccessBooleanWhether the message was successfully added

Examples

The following action will add a public message to the incident with ID 3773011:

{
  "host": "https://your_site.custhelp.com",
  "username": "your_username",
  "password": "your_password",
  "incidentId": "3773011",
  "message": "This is a public message",
  "isPrivate": false
}

This query returns the following data:

{
  "success": true
}

The following action will add a private message to the incident with ID 3773011:

{
  "host": "https://your_site.custhelp.com",
  "username": "your_username",
  "password": "your_password",
  "incidentId": "3773011",
  "message": "This is a private message",
  "isPrivate": true
}

This query returns the following data:

{
  "success": true
}

Note that the output of Success will be false if any of the following occurs:

  • The API call is unsuccessful (i.e., there is an error when making the API call), OR;
  • The API call is successful (response code 200) but the response does not contain the expected data.