Retrieve an instance of eventSubscriptions

get

/services/rest/connect/latest/eventSubscriptions/{id}

Request

Path Parameters

Response

Supported Media Types

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 GET with the following syntax to retrieve data for an event subscription object:

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

Request URI example

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

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