Create an instance of eventSubscriptions

post

/services/rest/connect/v1.4/eventSubscriptions

Request

Body ()
An event-based subscription management object
Root Schema : eventSubscriptions
Type: object
An event-based subscription management object
Show Source
Nested Schema : namedIDs-eventSubscriptions-eventType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-integrationUser
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-objectVersion
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-status
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Response

Default Response

Body ()
An event-based subscription management object
Root Schema : eventSubscriptions
Type: object
An event-based subscription management object
Show Source
Nested Schema : namedIDs-eventSubscriptions-eventType
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-integrationUser
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-objectVersion
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
Nested Schema : namedIDs-eventSubscriptions-status
Type: object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source

Examples

Use POST with the following syntax to create a new event subscription object:

https://your_site_interface/services/rest/connect/version/eventSubscriptions

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions

Request body example

{
"name": "MyContactCreateSubscription",
"class": "Contact",
"endPoint": "https://myEventReceiverService",
"eventType": {
    "id": 1},
"integrationUser": {
    "id": 1},
"objectVersion": {
    "id": 100300},
"objectShapeXml": "<n0:TriggeringObject xmlns:n0=&quot;urn:messages.ws.rightnow.com/v1_4&quot;
 xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot; xsi:type=&quot;n1:Contact&quot;
 xmlns:n1=&quot;urn:objects.ws.rightnow.com/v1_4&quot;><n1:Notes></n1:Notes></n0:TriggeringObject>"
}

Note:

  • All of the fields in the example request body are required for event subscriptions.
  • The endpoint URL must point to a SOAP service that implements or conforms to the event WSDL. The event WSDL can be found at:
    http://your_site_interface/cgi-bin/your_interface.cfg/services/soap?wsdl=event
  • Quotation marks inside the objectShapeXml field value must be escaped (replaced with &quot; or \") to avoid JSON syntax errors. You must also preserve spaces between XML namespace attributes.

Response body example

{
  "id": 10004,
  "lookupName": "MyContactCreateSubscription",
  "createdTime": "2016-03-22T13:44:30.000Z",
  "updatedTime": "2016-03-22T13:44:30.000Z",
  "class": "Contact",
  "endPoint": "https://myEventReceiverService",
  "eventType": {
    "id": 1,
    "lookupName": "Create"
  },
  "integrationUser": {
    "id": 1,
    "lookupName": "ICS Integration"
  },
  "name": "MyContactCreateSubscription",
  "objectShapeXml": "<n0:TriggeringObject xmlns:n0="urn:messages.ws.rightnow.com/v1_4"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="n1:Contact"
    xmlns:n1="urn:objects.ws.rightnow.com/v1_4"><n1:Notes></n1:Notes></n0:TriggeringObject>",
  "objectVersion": {
    "id": 100300,
    "lookupName": "v1.4"
  },
  "status": {
    "id": 1,
    "lookupName": "Active"
  },
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10004"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/eventSubscriptions/10004"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/
       eventSubscriptions",
      "mediaType": "application/schema+json"
    }
  ]
}